Developers
Subscriptions

Get a subscription

GET
/subscriptions/{id}

Returns one subscription. Use status and current_period_end to decide whether the customer has access.

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The resource id

Formatuuid

Response Body

Success

application/json
  1. response
id*string
status*string
Value in"incomplete""trialing""active""past_due""paused""canceled""expired"
kind*string

membership: unlocks products of the store. subscription: external digital access — grant it in your own app.

Value in"membership""subscription"
product_id*string
product_name*string
plan_id*string

The plan (product variant) subscribed to

plan_title*string
billing_cycle*

Billed every interval_count units; null = lifetime

price*string

Charged each billing period, before VAT

currency*string
Length3 <= length <= 3
customer*
answers*array<>

The customer's answers to the product's form fields

trial_ends_at*string

ISO 8601 timestamp

current_period_start*string

ISO 8601 timestamp

current_period_end*string

Access runs until here; null = lifetime

next_billing_at*string

ISO 8601 timestamp

cancel_at_period_end*boolean

Canceled, but runs until current_period_end

canceled_at*string

ISO 8601 timestamp

canceled_by*string
Value in"customer""vendor""system"
cancel_reason*string
started_at*string

ISO 8601 timestamp

ended_at*string

ISO 8601 timestamp

latest_order_id*string

The most recent paid order of this subscription

created_at*string

ISO 8601 timestamp

updated_at*string

ISO 8601 timestamp

object*"subscription"
Value in"subscription"
curl -X GET "https://example.com/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"}

List subscriptions GET

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.

Pagination & filters

Walk through lists and keep another system in sync.