v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Subscription Bills

List all bills

Returns a paginated list of bills across all subscriptions.

get/bills

Query parameters

subscription_idstring

Filter by subscription ID.

customer_idstring uuid

Filter by customer ID.

Filter by bill status.

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

Response

List of bills.

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "id": "01HNY4G8G8P4E1T4YJ9N8B1Z9M",
      "subscription_id": "01HNY4G8G5ZMAXQB8T0Z1Y1ZMW",
      "customer": {
        "customer_id": "c3e06b6f-bb52-4b2c-81a3-899860652240"
      },
      "status": "paid",
      "amount": {
        "base": 19.99,
        "discount": 4,
        "total": 15.99,
        "status": "finalised"
      },
      "currency": "GBP",
      "due_date": "2025-11-17T17:00:00Z",
      "transactions": [
        {
          "transaction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "status": "success",
          "type": "payment",
          "payment_method": "card"
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "/v1/subscriptions/01HNY4G8G5ZMAXQB8T0Z1Y1ZMW/bills/01HNY4G8G8P4E1T4YJ9N8B1Z9M",
          "method": "GET"
        }
      ]
    }
  ]
}