Sign in

v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Invoice

Gets an invoice by ID.

get/invoice/{invoiceId}

Path parameters

invoiceIdstring required

The invoice ID.

Response

OK

idstring required

The invoice ID.

billingPeriodIdstring required

The billing period this invoice belongs to.

billingPeriodStartstring date-time required

The start date of the billing period.

billingPeriodEndstring date-time required

The end date of the billing period.

stripeInvoiceIdstring nullable

The Stripe invoice ID.

status'Generating' | 'Draft' | 'Open' | 'Paid' | 'Void' | 'Uncollectible' | 'Failed' required
amountDueinteger required

The total amount due in cents.

currencystring nullable

The invoice currency.

createdAtstring date-time required

When the invoice was created.

finalizedAtstring date-time nullable

When the invoice was finalized.

paidAtstring date-time nullable

When the invoice was paid.