Developers
Subscriptions

List subscriptions

GET
/subscriptions

Lists the customers' subscriptions to the store's memberships, newest first, with the plan, billing cycle, price, customer and current period. Filter by status, membership product, plan or date. Checkouts not paid yet are not included.

Authorization

apiKey
headerAuthorizationBearer <token>

A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….

Query Parameters

limit?integer

Page size, 1–100

Range1 <= value <= 100
Default25
cursor?string

next_cursor from the previous page

Lengthlength <= 500
order?string

Sort by created_at; newest first by default

Default"desc"
Value in"desc""asc"
created_after?string

Only records created after this time

Formatdate-time
created_before?string

Only records created before this time

Formatdate-time
updated_after?string

Only records changed after this time — poll with your last sync time

Formatdate-time
updated_before?string

Only records changed before this time

Formatdate-time
status?string
Value in"trialing""active""past_due""paused""canceled""expired"
product_id?string

Only subscriptions to this membership product

Formatuuid
plan_id?string

Only subscriptions on this plan (product variant)

Formatuuid

Response Body

Success

application/json
  1. response
object*"list"
Value in"list"
data*array<>
has_more*boolean

Whether another page exists

next_cursor*string

Pass as cursor to get the next page; null on the last

curl -X GET "https://example.com/subscriptions"
{  "object": "list",  "data": [    {      "id": "00000000-0000-4000-8000-000000000501",      "status": "active",      "kind": "subscription",      "product_id": "00000000-0000-4000-8000-000000000204",      "product_name": "Pro Design Toolkit",      "plan_id": "00000000-0000-4000-8000-000000000304",      "plan_title": "Pro",      "billing_cycle": {        "unit": "month",        "interval_count": 1      },      "price": "99.00",      "currency": "SAR",      "customer": {        "id": "00000000-0000-4000-8000-000000000010",        "name": "Sara Ahmed",        "email": "[email protected]",        "phone": "+966500000000"      },      "answers": [        {          "label": "Company name",          "value": "Ahmed Studio"        }      ],      "trial_ends_at": null,      "current_period_start": "2026-10-01T10:00:00.000Z",      "current_period_end": "2026-11-01T10:00:00.000Z",      "next_billing_at": "2026-11-01T10:00:00.000Z",      "cancel_at_period_end": false,      "canceled_at": null,      "canceled_by": null,      "cancel_reason": null,      "started_at": "2026-10-01T10:00:00.000Z",      "ended_at": null,      "latest_order_id": "00000000-0000-4000-8000-000000000002",      "created_at": "2026-10-01T09:58:00.000Z",      "updated_at": "2026-10-01T10:00:00.000Z",      "object": "subscription"    }  ],  "has_more": false,  "next_cursor": null}