Sign in

v13

OpenAPI 3.0.32026-07-31359869.4 MB
marketplace

Get Invoice

Get Invoice details and status for a given invoice ID.<br/> <br/> See Billing Events with Webhooks documentation on how to receive invoice events. This endpoint is used to retrieve the invoice details.

get/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}

Path parameters

integrationConfigurationIdstring required
invoiceIdstring required

Response

testfalse | true

Whether the invoice is in the testmode (no real transaction created).

invoiceIdstring required

Vercel Marketplace Invoice ID.

externalIdstring

Partner-supplied Invoice ID, if applicable.

state'draft' | 'invoiced' | 'notpaid' | 'overdue' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled' required

Invoice state.

invoiceNumberstring

User-readable invoice number.

invoiceDatestring required

Invoice date. ISO 8601 timestamp.

paidAtstring

Moment the invoice was paid. ISO 8601 timestamp.

refundedAtstring

Most recent moment the invoice was refunded. ISO 8601 timestamp.

memostring

Additional memo for the invoice.

totalstring required

Invoice total amount. A dollar-based decimal string.

refundReasonstring

The reason for refund. Only applicable for states "refunded" or "refund_request".

refundTotalstring

Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.

createdstring required

System creation date. ISO 8601 timestamp.

updatedstring required

System update date. ISO 8601 timestamp.