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": "6292110d-a465-4b7f-b7a3-bf8fbf98bc22",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1778768549,
      "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": 1776176549,
      "status": "paid",
      "checkout": "800aebaa-935f-4d46-93cc-b6064eb816b3",
      "price": "5bd9149d-53bc-486e-9d54-d16d4af45caa",
      "subscription": "17e09329-b4d2-4ca1-927a-041e85a7ce62",
      "variant": null,
      "created_at": 1776176549,
      "updated_at": 1776176549
    },
    {
      "id": "ca5a7860-3ee7-4a44-9374-44df8156a5f6",
      "object": "period",
      "ad_hoc_amount": null,
      "end_at": 1778768549,
      "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": 1776176549,
      "status": "paid",
      "checkout": "151836b1-5f30-4093-a4a8-0f409b5db2f1",
      "price": "5bd9149d-53bc-486e-9d54-d16d4af45caa",
      "subscription": "17e09329-b4d2-4ca1-927a-041e85a7ce62",
      "variant": null,
      "created_at": 1776176549,
      "updated_at": 1776176549
    }
  ]
}

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.