Skip to content
Docs

Get Invoice

GEThttps://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}
Get Invoice details and status for a given invoice ID.

See Billing Events with Webhooks documentation on how to receive invoice events. This endpoint is used to retrieve the invoice details.
https://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}
const response = await fetch('https://api.vercel.com/v1/installations/integrationConfigurationId/billing/invoices/invoiceId', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "created": "string",
  "discounts": [
    {
      "amount": "100.00",
      "billingPlanId": "example_id",
      "details": "Example details",
      "end": "string",
      "name": "Example Name",
      "resourceId": "example_id",
      "start": "string"
    }
  ],
  "externalId": "example_id",
  "invoiceDate": "string",
  "invoiceId": "example_id",
  "invoiceNumber": "string",
  "items": [
    {
      "billingPlanId": "example_id",
      "details": "Example details",
      "end": "string",
      "name": "Example Name",
      "price": "100.00",
      "quantity": "1",
      "resourceId": "example_id",
      "start": "string",
      "total": "100.00",
      "units": "units"
    }
  ],
  "memo": "string",
  "paidAt": "example_id",
  "period": {
    "end": "string",
    "start": "string"
  },
  "refundedAt": "string",
  "refundReason": "Customer requested refund",
  "refundTotal": "100.00",
  "state": "draft",
  "test": "false",
  "total": "100.00",
  "updated": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired
invoiceIdstringRequired

Response

200Success
createdstringRequired
System creation date. ISO 8601 timestamp.
discountsarrayOptional
Invoice discounts.
externalIdstringOptional
Partner-supplied Invoice ID, if applicable.
invoiceDatestringRequired
Invoice date. ISO 8601 timestamp.
invoiceIdstringRequired
Vercel Marketplace Invoice ID.
invoiceNumberstringOptional
User-readable invoice number.
itemsarrayRequired
Invoice items.
memostringOptional
Additional memo for the invoice.
paidAtstringOptional
Moment the invoice was paid. ISO 8601 timestamp.
periodobjectRequired
Subscription period for this billing cycle. ISO 8601 timestamps.
refundedAtstringOptional
Most recent moment the invoice was refunded. ISO 8601 timestamp.
refundReasonstringOptional
The reason for refund. Only applicable for states "refunded" or "refund_request".
refundTotalstringOptional
Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.
statestringRequired
Invoice state.
testbooleanOptional
Whether the invoice is in the testmode (no real transaction created).
totalstringRequired
Invoice total amount. A dollar-based decimal string.
updatedstringRequired
System update date. ISO 8601 timestamp.

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error
429Error
Get Invoice | Vercel API