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": "deb54c20-0bb2-4131-8c3c-2462e641dde5",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1773845483,
      "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": 1771429883,
      "status": "paid",
      "checkout": "ac7ff3a7-d23c-479f-92e6-5129935ae234",
      "price": "fa38dda2-c92b-42a4-91a8-d303beb299c8",
      "subscription": "5bd637e4-e4fc-4dbc-ae78-e47a38065872",
      "variant": null,
      "created_at": 1771429883,
      "updated_at": 1771429883
    },
    {
      "id": "285b0ce1-a730-4798-ad20-4bafeccc3898",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1773845483,
      "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": 1771429883,
      "status": "paid",
      "checkout": "81f586cd-7f31-423e-abd2-342e6bf03b93",
      "price": "fa38dda2-c92b-42a4-91a8-d303beb299c8",
      "subscription": "5bd637e4-e4fc-4dbc-ae78-e47a38065872",
      "variant": null,
      "created_at": 1771429883,
      "updated_at": 1771429883
    }
  ]
}

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.