This feature is only available in the Enterprise version
Billing
List invoices
List invoices for your Blnk Cloud organization.
GET/billing/invoices
Use this to list past invoices for the organization. invoice_pdf and hosted_url are hosted Stripe links.
Enterprise authentication
Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.
Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.
This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.
X-blnk-keystringrequiredheader
Enterprise API key, or an OAuth access token.
Response
invoicesarray
Invoice objects for the organization.
Details
idstring
Invoice id (in_...).
numberstring
Invoice number.
statusstring
Invoice status, such as paid or open.
amount_dueinteger
Amount due in the smallest currency unit.
amount_paidinteger
Amount paid in the smallest currency unit.
currencystring
ISO currency code, such as usd.
descriptionstring
Line description, such as Sandbox Deployment.
invoice_pdfstring
URL of the PDF invoice.
hosted_urlstring
URL of the hosted invoice page.
period_startinteger
Unix timestamp (seconds) for the start of the invoice period.
period_endinteger
Unix timestamp (seconds) for the end of the invoice period.
createdinteger
Unix timestamp (seconds) when the invoice was created.
subscription_idstring
Subscription id this invoice belongs to (sub_...). Can be empty.
