Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Billing

List billing invoices

Returns finalized invoices and their complete line items for the authenticated account, newest first. All monetary amounts are in the currency's smallest unit.

get/v1/billing/invoice

Query parameters

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

Response

OK

Example response

{
  "data": [
    {
      "amount_due": 9540,
      "amount_paid": 9540,
      "currency": "usd",
      "discount_amount": 1000,
      "invoice_id": "in_AbCdEfGhIjKlMn",
      "line_items": [
        {
          "description": "Slide Z1 Subscription, 1 TB, 1 Year Cloud Retention",
          "device_ids": [
            "d_0123456789ab"
          ],
          "discount_amount": 1000,
          "quantity": 2,
          "sku": "sm_p0000z1s1cr1",
          "subtotal_amount": 10000,
          "tax_amount": 540,
          "total_amount": 9540,
          "unit_amount": 5000
        }
      ],
      "number": "000123-0001",
      "subtotal_amount": 10000,
      "tax_amount": 540,
      "total_amount": 9540
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}