VercelVercel
Menu

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/string/billing/invoices/string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "test": "false",
  "invoiceId": "string",
  "externalId": "string",
  "state": "pending",
  "invoiceNumber": "string",
  "invoiceDate": "string",
  "period": {
    "start": "string",
    "end": "string"
  },
  "paidAt": "string",
  "refundedAt": "string",
  "memo": "string",
  "items": [],
  "discounts": [],
  "total": "string",
  "refundReason": "string",
  "refundTotal": "string",
  "created": "string",
  "updated": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired
invoiceIdstringRequired

Response

testbooleanOptional
Whether the invoice is in the testmode (no real transaction created).
invoiceIdstringRequired
Vercel Marketplace Invoice ID.
externalIdstringOptional
Partner-supplied Invoice ID, if applicable.
statestringRequired
Invoice state.
invoiceNumberstringOptional
User-readable invoice number.
invoiceDatestringRequired
Invoice date. ISO 8601 timestamp.
periodobjectRequired
Subscription period for this billing cycle. ISO 8601 timestamps.
paidAtstringOptional
Moment the invoice was paid. ISO 8601 timestamp.
refundedAtstringOptional
Most recent moment the invoice was refunded. ISO 8601 timestamp.
memostringOptional
Additional memo for the invoice.
itemsarrayRequired
Invoice items.
discountsarrayOptional
Invoice discounts.
totalstringRequired
Invoice total amount. A dollar-based decimal string.
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.
createdstringRequired
System creation date. ISO 8601 timestamp.
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
Get Invoice | Vercel API