Skip to main content
GET
/
v1
/
periods
List
curl --request GET \
  --url https://{defaultHost}/v1/periods \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 2,
    "limit": 20,
    "page": 1,
    "url": "/v1/periods"
  },
  "data": [
    {
      "id": "9f3230bc-79bb-4d3e-8afa-0a8de722dc8f",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1780689299,
      "next_payment_retry_at": null,
      "payment_retry_count": 0,
      "payoff": false,
      "quantity": 1,
      "renewal": false,
      "renewal_reminder_sent_at": null,
      "restoral": false,
      "skip_proration": false,
      "start_at": 1778010899,
      "status": "paid",
      "checkout": "a8fa4abc-db10-49cf-bc2f-d36c3918f6ca",
      "price": "a3bb35eb-2958-45c9-95cb-6fe6b8de71cf",
      "subscription": "99f6794d-0cd6-4b37-b5c9-46d5b3d333ae",
      "variant": null,
      "created_at": 1778010899,
      "updated_at": 1778010899
    },
    {
      "id": "88239ed1-0402-43f4-aeb8-f32e16891b06",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1780689299,
      "next_payment_retry_at": null,
      "payment_retry_count": 0,
      "payoff": false,
      "quantity": 1,
      "renewal": false,
      "renewal_reminder_sent_at": null,
      "restoral": false,
      "skip_proration": false,
      "start_at": 1778010899,
      "status": "paid",
      "checkout": "41da8dee-9110-4de7-bccb-5dc2516383d3",
      "price": "a3bb35eb-2958-45c9-95cb-6fe6b8de71cf",
      "subscription": "99f6794d-0cd6-4b37-b5c9-46d5b3d333ae",
      "variant": null,
      "created_at": 1778010899,
      "updated_at": 1778010899
    }
  ]
}

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

​
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.

​
page
integer

The page of items you want returned.

​
subscription_ids[]
string[]

Only return objects that belong to the given subscriptions.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.