comecerodocs
Subscriptions

List subscriptions

GET
/subscriptions

Lists the subscriptions in your account, oldest first by date_type (default date_created). The list is cursor-based: use next_page_url or after_item to page forward. Secret and trusted tokens may call it. A limited token may not (403); a signed-in customer reads their own with GET /customers/{customer_id}/subscriptions.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

status?string

Only subscriptions with this status. Cannot be sent with terminated.

Value in"trial""active""cancelled""completed"
terminated?boolean

true returns cancelled and completed subscriptions, false returns trial and active ones. Cannot be sent with status.

in_grace_period?boolean

Only subscriptions that are, or are not, in the grace period after a failed renewal.

q?string

Search by exact subscription id, exact customer email, or part of the customer name or company name.

date_type?string

Which date date_start and date_end filter on, and the list is sorted by. date_current_period_start and date_current_period_end cannot be used with status=cancelled, status=completed or terminated=true.

Default"date_created"
Value in"date_created""date_modified""date_current_period_start""date_current_period_end"
date_start?string

Only items on or after this date. Send ISO 8601 (2026-11-01T00:00:00Z or 2026-11-01T00:00:00-05:00) or a shorthand: 2026 means the start of 2026, 2026-11 the start of November, 2026-11-01 the start of that day. A date with no offset is read in timezone, or in the account's time zone when you send none. It must not be after date_end (400).

date_end?string

Only items on or before this date. Same formats as date_start, but a shorthand means the end of the period: 2026-11 is the last instant of November, 2026-11-30 the last instant of that day. A date with no offset is read in timezone, or in the account's time zone when you send none.

timezone?string

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
after_item?string

For cursor-based lists, return the items after the item with this id. Use next_page_after_item (or follow next_page_url) from the page you have. You cannot send it together with before_item (400). An id that does not exist is a 404.

before_item?string

For cursor-based lists, return the items before the item with this id. Use previous_page_before_item (or follow previous_page_url) from the page you have. You cannot send it together with after_item (400). An id that does not exist is a 404.

desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

A page of subscriptions.

application/json
  1. response

A cursor-based page of subscriptions.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_after_item*|

The after_item value for the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_before_item*|

The before_item value for the previous page, or null on the first page.

current_page_url*string

The URL of this page.

Formaturi
data*array<>

The subscriptions on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/subscriptions'
Example Response
{  "next_page_url": "https://api.comecero.com/api/v1/subscriptions?after_item=0093799318129SuLByRPW8&status=active",  "next_page_after_item": "0093799318129SuLByRPW8",  "previous_page_url": null,  "previous_page_before_item": null,  "current_page_url": "https://api.comecero.com/api/v1/subscriptions?status=active&limit=1",  "data": [    {      "object": "subscription",      "url": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8",      "subscription_id": "0093799318129SuLByRPW8",      "date_created": "2026-10-02T15:21:28Z",      "date_modified": "2026-11-02T15:21:31Z",      "test": true,      "account_id": "AB1234",      "status": "active",      "in_grace_period": false,      "billing_interval": 1,      "billing_interval_unit": "month",      "billing_interval_description": "1 month",      "trial_interval": null,      "trial_interval_unit": null,      "trial_interval_description": null,      "billing_count": 2,      "end_at_billing_count": null,      "currency": "USD",      "items": [        {          "object": "subscription_item",          "url": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8/items/acme-pro.test",          "item_id": "acme-pro.test",          "date_created": "2026-10-02T15:21:28Z",          "date_modified": "2026-10-02T15:21:28Z",          "product_id": "acme-pro.test",          "name": "Acme Pro (monthly)",          "quantity": 1,          "reference_price": 19.95,          "reference_currency": "USD",          "reference_discount": 0,          "reference_discount_price": null,          "discount_apply_count": null,          "discount_applied_count": 0,          "cancelled": false,          "cancel_at_current_period_end": false,          "date_cancelled": null,          "date_ended": null,          "cancellation_reason": null,          "tax_code": null,          "type": "digital",          "change_at_current_period_end": null,          "product": "https://api.comecero.com/api/v1/products/acme-pro.test",          "subscription": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8",          "subscription_terms": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8/items/acme-pro.test/subscription_terms",          "meta": null        }      ],      "shipping_method_id": null,      "date_trial_start": null,      "date_trial_end": null,      "date_current_period_start": "2026-11-02T15:21:28Z",      "date_current_period_end": "2026-12-02T15:21:28Z",      "date_next_renewal_notification": "2026-11-29T15:21:28Z",      "date_cancelled": null,      "cancellation_reason": null,      "cancel_at_current_period_end": false,      "date_ended": null,      "add_at_current_period_end": [],      "subscription_plan": "https://api.comecero.com/api/v1/subscription_plans/0093472113202Spzs4AV8C",      "customer": "https://api.comecero.com/api/v1/customers/0093799288003CuGOip8X9",      "invoices": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8/invoices",      "history": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8/history",      "meta": null    }  ]}

Overview

Previous Page

Get subscription options GET

Returns choices for managing subscriptions, such as the cancellation reasons set in your subscription settings. Secret and trusted tokens may call it; a limited token may not (`403`).