Skip to main content
GET
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.billing.io/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "sub_1a2b3c4d5e",
      "org_id": "<string>",
      "customer_id": "<string>",
      "plan_id": "<string>",
      "payment_method_id": "<string>",
      "current_period_start": "2023-11-07T05:31:56Z",
      "current_period_end": "2023-11-07T05:31:56Z",
      "trial_end": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "cancel_at_period_end": true,
      "pause_start": "2023-11-07T05:31:56Z",
      "pause_end": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "customer": {
        "id": "cus_1a2b3c4d5e",
        "org_id": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "external_id": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "plan": {
        "id": "plan_1a2b3c4d5e",
        "org_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "amount": 123,
        "currency": "<string>",
        "interval_count": 123,
        "trial_days": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}
List subscriptions with optional filters for status and customer. 
curl "https://api.billing.io/v1/subscriptions?status=active&limit=10" \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Query Parameters

​
cursor
string

Opaque cursor for pagination. Omit for the first page.

​
limit
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
status
enum<string>
  • trialing — Subscription is in trial period
  • active — Subscription is active and billing normally
  • past_due — Payment failed, retrying
  • paused — Subscription is paused
  • canceled — Subscription was canceled
  • expired — Subscription has expired
Available options:
trialing,
active,
past_due,
paused,
canceled,
expired
​
customer_id
string

Filter by customer identifier

Response

Subscription list

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null