List invoices

List invoices for your Blnk Cloud organization.

GET /billing/invoices

cURL

curl -X GET "https://api.cloud.blnkfinance.com/billing/invoices" \
  -H "Authorization: Bearer CLOUD_API_KEY"

200

{
  "invoices": [
    {
      "id": "in_1ABC123",
      "number": "INV-0001",
      "status": "paid",
      "amount_due": 0,
      "amount_paid": 5000,
      "currency": "usd",
      "description": "Sandbox Deployment",
      "invoice_pdf": "https://pay.stripe.com/invoice/...",
      "hosted_url": "https://invoice.stripe.com/i/...",
      "period_start": 1789118347,
      "period_end": 1791710347,
      "created": 1789118347,
      "subscription_id": "sub_1ABC123"
    }
  ]
}

Use this to list past invoices for the organization. invoice_pdf and hosted_url are hosted Stripe links.

---

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN.

Bearer token

Pass Authorization: Bearer CLOUD_API_KEY or Authorization: Bearer OAUTH_ACCESS_TOKEN.

Authorization · string · required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

X-Blnk-Key header

Pass X-Blnk-Key: CLOUD_API_KEY or X-Blnk-Key: OAUTH_ACCESS_TOKEN.

X-Blnk-Key · string · required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

X-API-Key header

Pass X-API-Key: CLOUD_API_KEY or X-API-Key: OAUTH_ACCESS_TOKEN.

X-API-Key · string · required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

cURL

curl -X GET "https://api.cloud.blnkfinance.com/billing/invoices" \
  -H "Authorization: Bearer CLOUD_API_KEY"

Response

200

{
  "invoices": [
    {
      "id": "in_1ABC123",
      "number": "INV-0001",
      "status": "paid",
      "amount_due": 0,
      "amount_paid": 5000,
      "currency": "usd",
      "description": "Sandbox Deployment",
      "invoice_pdf": "https://pay.stripe.com/invoice/...",
      "hosted_url": "https://invoice.stripe.com/i/...",
      "period_start": 1789118347,
      "period_end": 1791710347,
      "created": 1789118347,
      "subscription_id": "sub_1ABC123"
    }
  ]
}

invoices · array

Invoice objects for the organization.

Show child attributes

id · string

Invoice id (in_...).

number · string

Invoice number.

status · string

Invoice status, such as paid or open.

amount_due · integer

Amount due in the smallest currency unit.

amount_paid · integer

Amount paid in the smallest currency unit.

currency · string

ISO currency code, such as usd.

description · string

Line description, such as Sandbox Deployment.

invoice_pdf · string

URL of the PDF invoice.

hosted_url · string

URL of the hosted invoice page.

period_start · integer

Unix timestamp (seconds) for the start of the invoice period.

period_end · integer

Unix timestamp (seconds) for the end of the invoice period.

created · integer

Unix timestamp (seconds) when the invoice was created.

subscription_id · string

Subscription id this invoice belongs to (sub_...). Can be empty.

---

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.

To ask questions or discuss issues, please contact us or join our Discord community.