Documentation menu

List the org's Stripe invoices (receipts) with links to their PDFs

GEThttps://api.instacloud.com/orgs/{orgId}/billing/invoices

Token scope: account · org — read-only tokens allowed.

Parameters

NameInTypeRequiredDescription
limitqueryintegerno
beforequerystringnoopaque cursor from a previous page's nextBefore
orgIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
itemsobject[]yes
items.idstringyesStripe invoice id
items.numberstring | nullyesthe invoice number printed on the PDF; null before Stripe assigns one
items.createdAtstringyes
items.amountUsdnumberyesinvoice total in USD
items.currencystringyes
items.statusstringyesStripe invoice status — paid, open or uncollectible (drafts and voided invoices are never listed)
items.descriptionstring | nullyesthe invoice's description, else its first line item — what was bought
items.pdfUrlstring | nullyesStripe-hosted, read-only PDF; null until Stripe has rendered it. The payable hosted invoice link is deliberately never returned.
nextBeforestring | nullnoopaque cursor; pass as ?before= for the next page, null when there are no more

403

Default Response

FieldTypeRequiredDescription
errorstringyes

409

Default Response

FieldTypeRequiredDescription
errorstringyes

503

Billing (Stripe) not configured

View as Markdown