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": "c09c7eac-4610-41e2-954f-5d0c3f7e055d",
      "object": "subscription",
      "ad_hoc_amount": null,
      "affiliation_expires_at": null,
      "cancel_at_period_end": false,
      "currency": "usd",
      "current_period_end_at": 1780689334,
      "current_period_start_at": 1778010934,
      "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/c09c7eac-4610-41e2-954f-5d0c3f7e055d",
      "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": "ff02c0ff-1af1-4821-a1eb-5bc98023e2e4",
      "customer": "d040a613-55d4-4343-a08f-a57d7ea1f004",
      "discount": null,
      "manual_payment_method": null,
      "payment_method": "048e7113-8e4a-4b81-93b2-9abff3e55915",
      "price": "14f7e781-a690-424c-8554-740f6cdc188d",
      "purchase": "b34f1230-761c-4614-a80d-b7ca739e8425",
      "shipping_method": null,
      "variant": null,
      "created_at": 1778010934,
      "updated_at": 1778010934
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.surecart.com/llms.txt

Use this file to discover all available pages before exploring further.

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.