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": "236c5b6f-864b-4da9-adb0-4532655ea1d5",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1774532192,
      "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": 1772112992,
      "status": "paid",
      "checkout": "ce592012-ab91-4bc4-a7dd-aca7c758f3da",
      "price": "eeafa3ef-a3ad-4257-b43e-119cad8e5b6e",
      "subscription": "bcfc5995-3be2-42bd-9a17-d1b80ef91464",
      "variant": null,
      "created_at": 1772112992,
      "updated_at": 1772112992
    },
    {
      "id": "efcfb961-725d-46f4-85b1-43b977f2b845",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1774532192,
      "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": 1772112992,
      "status": "paid",
      "checkout": "35f71306-6939-42f4-9b49-0869a2250a62",
      "price": "eeafa3ef-a3ad-4257-b43e-119cad8e5b6e",
      "subscription": "bcfc5995-3be2-42bd-9a17-d1b80ef91464",
      "variant": null,
      "created_at": 1772112992,
      "updated_at": 1772112992
    }
  ]
}

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.