Skip to main content
GET
List renewal cycles

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string

Required for platform keys; refused for secret/publishable keys.

payments-version
enum<string>
Available options:
2026-11-01

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string
Minimum string length: 1
store
string
Pattern: ^store_[a-f0-9]{12}$
status
enum<string>
Available options:
scheduled,
trying,
waiting_retry,
waiting_card_update,
waiting_customer,
waiting_merchant,
succeeded,
failed,
canceled
subscription
string

Cycles collecting this subscription, alone or through its group.

Minimum string length: 1
due_gte
string<date-time>
due_lt
string<date-time>

Response

A page of renewal cycles.

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
object
enum<string>
required
Available options:
list