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": "071d84bc-7192-481a-9a17-7aa7bb5b5f2f",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1772266969,
      "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": 1769674969,
      "status": "paid",
      "checkout": "cfe45ea4-a71e-495b-8b4a-0b1f2257e27f",
      "price": "e6aea649-7dd5-424c-8569-e75d503cc4ca",
      "subscription": "1dc126a6-f533-4bcd-aa05-4952a125c46f",
      "variant": null,
      "created_at": 1769674969,
      "updated_at": 1769674969
    },
    {
      "id": "d4241d0c-b12c-4423-b03e-6ff5fc063935",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1772266969,
      "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": 1769674969,
      "status": "paid",
      "checkout": "a67631a5-e078-4e18-88ee-a5dd1cba6fc1",
      "price": "e6aea649-7dd5-424c-8569-e75d503cc4ca",
      "subscription": "1dc126a6-f533-4bcd-aa05-4952a125c46f",
      "variant": null,
      "created_at": 1769674969,
      "updated_at": 1769674969
    }
  ]
}

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.