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": "6cea2edd-2a3f-4557-b1a2-5345f5b5e3cb",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1782927118,
      "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": 1780335118,
      "status": "paid",
      "checkout": "edb023f3-84fe-4558-a6d1-94966b440162",
      "price": "40d0aeac-2564-408f-8666-d8e076b265f0",
      "subscription": "1834e611-7b1a-4e5d-847a-c3a7ed4e5a84",
      "variant": null,
      "created_at": 1780335118,
      "updated_at": 1780335118
    },
    {
      "id": "62078294-26cd-45cc-a131-6c5a298a9c4c",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1782927117,
      "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": 1780335117,
      "status": "paid",
      "checkout": "77746d02-8193-49ae-b491-b0d2566adb3c",
      "price": "40d0aeac-2564-408f-8666-d8e076b265f0",
      "subscription": "1834e611-7b1a-4e5d-847a-c3a7ed4e5a84",
      "variant": null,
      "created_at": 1780335117,
      "updated_at": 1780335117
    }
  ]
}

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.