Skip to main content
GET
/
v1
/
subscriptions
List
curl --request GET \
  --url https://{defaultHost}/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/subscriptions"
  },
  "data": [
    {
      "id": "f8243e1e-f3c3-4830-b4d7-fe6bfc99f4d4",
      "object": "subscription",
      "ad_hoc_amount": null,
      "affiliation_expires_at": null,
      "cancel_at_period_end": false,
      "currency": "usd",
      "current_period_end_at": 1778768584,
      "current_period_start_at": 1776176584,
      "ended_at": null,
      "finite": false,
      "last_renewal_reminder_sent_at": null,
      "live_mode": true,
      "manual_payment": false,
      "metadata": {},
      "pending_update": {},
      "price_readonly": false,
      "portal_url": "http://app.example.com/portal_redirect/subscriptions/f8243e1e-f3c3-4830-b4d7-fe6bfc99f4d4",
      "quantity": 1,
      "remaining_period_count": null,
      "restart_on_completed": false,
      "restore_at": null,
      "subtotal_amount": 2900,
      "status": "active",
      "tax_enabled": false,
      "trial_end_at": null,
      "trial_start_at": null,
      "variant_options": null,
      "affiliation": null,
      "current_cancellation_act": null,
      "current_period": "10971e2e-1b8b-4663-ab6d-516d4b8f6e68",
      "customer": "780e309d-c2cf-4692-b528-2d4102687f64",
      "discount": null,
      "manual_payment_method": null,
      "payment_method": "99f13947-e7de-47f1-a029-b7b3a77f00fe",
      "price": "6e7ea2c2-3cf1-4499-a679-421a37a7fa25",
      "purchase": "73fe0bcb-84ba-45fd-8e3c-358f4b328116",
      "shipping_method": null,
      "variant": null,
      "created_at": 1776176584,
      "updated_at": 1776176584
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

customer_ids[]
string[]

Only return objects that belong to the given customers.

finite
boolean

Only return subscriptions that are finite or not.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

live_mode
boolean

Only return objects that are live mode or test mode.

page
integer

The page of items you want returned.

price_ids[]
string[]

Only return objects that belong to the given prices.

product_ids[]
string[]

Only return objects that belong to the given products.

purchase_ids[]
string[]

Only return objects that belong to the given purchases.

query
string

The query to be used for full text search of this collection.

status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.