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": "92eebb39-b3bf-48d6-9a81-764b89ffa66a",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1770588132,
      "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": 1767909732,
      "status": "paid",
      "checkout": "bf3c1b67-3be1-4d33-9b93-303e821b250e",
      "price": "f50c0116-ca7c-4c2c-a3e9-bff56876e82f",
      "subscription": "58947505-6474-4baa-8a6f-fcb895a8e57e",
      "variant": null,
      "created_at": 1767909732,
      "updated_at": 1767909732
    },
    {
      "id": "7ca3a5dd-af9d-4a9e-a543-0672f600e2c6",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1770588131,
      "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": 1767909731,
      "status": "paid",
      "checkout": "e0f3763c-da53-4fbe-83be-ceec0adf5629",
      "price": "f50c0116-ca7c-4c2c-a3e9-bff56876e82f",
      "subscription": "58947505-6474-4baa-8a6f-fcb895a8e57e",
      "variant": null,
      "created_at": 1767909731,
      "updated_at": 1767909731
    }
  ]
}

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.