marketplace

Get Invoice

Changed on

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}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}
  • Auth: HTTP bearer

Path parameters

integrationConfigurationIdstring required
invoiceIdstring required

Response

createdstring required

System creation date. ISO 8601 timestamp.

externalIdstring

Partner-supplied Invoice ID, if applicable.

invoiceDatestring required

Invoice date. ISO 8601 timestamp.

invoiceIdstring required

Vercel Marketplace Invoice ID.

invoiceNumberstring

User-readable invoice number.

memostring

Additional memo for the invoice.

outstandingTotalstring

Amount still owed on the invoice, per the payment processor. Can be positive even for states "refunded" or "refund_requested", since a refund does not settle an unpaid remainder. A dollar-based decimal string. Absent when no payment data is available yet.

paidAtstring

Moment the invoice was paid. ISO 8601 timestamp.

paidTotalstring

Total amount paid and retained: payments received minus refunds applied. A dollar-based decimal string. Absent when no payment data is available yet.

pendingRefundTotalstring

Requested refund amount not yet applied by the payment processor: "refundTotal" minus "refundedTotal". A dollar-based decimal string. Only present when a refund was requested or applied.

refundedAtstring

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

refundedTotalstring

Total refund amount applied by the payment processor, on the same pre-tax basis as "refundTotal". Counts both money returned and debt cancelled on unpaid invoices. May be lower than "refundTotal", which is the requested amount. A dollar-based decimal string. Only present when a refund was requested or applied.

refundReasonstring

The reason for refund. Only present when a refund has been requested.

refundTotalstring

Total refund amount requested. Only present when a refund has been requested. A dollar-based decimal string.

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

Invoice state. Reports the payment state of the invoice; refund progress is reported separately via "refundedTotal" and "pendingRefundTotal". The states "refunded" and "refund_requested" only appear when the payment state cannot be determined.

testfalse | true

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

totalstring required

Invoice total amount. A dollar-based decimal string.

updatedstring required

System update date. ISO 8601 timestamp.

Changes

  • 08cb01e9f3a4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2ae10ee9d21cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status