Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Subscriptions

List Subscriptions

Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, or item prices.

get/v1/subscriptions

Query parameters

customerstring nullable

Filter by customer ID.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by customer ID.

expand_customerboolean nullable

If true, expands the customer object in the response.

If true, expands the customer object in the response.

starting_afterstring nullable

A cursor for use in pagination. starting_after is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with fsub_xyz, your subsequent call can include starting_after=fsub_xyz to fetch the next page.

Example:fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with fsub_xyz, your subsequent call can include starting_after=fsub_xyz to fetch the next page.

ending_beforestring nullable

A cursor for use in pagination. ending_before is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with fsub_abc, your subsequent call can include ending_before=fsub_abc to fetch the previous page.

Example:fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with fsub_abc, your subsequent call can include ending_before=fsub_abc to fetch the previous page.

status'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused'

The current lifecycle status of the subscription.

Example:incomplete

Filter by subscription status.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

expandstring

Comma-separated list of related objects to expand in the response.

Comma-separated list of related objects to expand in the response.

Response

An envelope wrapping a list of subscription objects.

Example response

{
  "subscriptions": [
    {
      "subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "created_at": "2026-06-15T14:30:00Z",
      "items": [],
      "status": "incomplete",
      "cancel_at_period_end": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "test_mode": false,
      "cancel_at": "2026-06-15T14:30:00Z",
      "canceled_at": "2026-06-15T14:30:00Z"
    }
  ]
}