Skip to content

AdminSupporterSubscriptionPage

A page of subscriptions, newest first.

object
next_cursor

An opaque pagination cursor. Clients pass it back unchanged and never parse it.

string
>= 1 characters <= 256 characters
items
required
Array<object>

A subscription as the administrators see it, without the history of its payments.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
state
required

The state of a subscription. pending: started, not paid yet. active: paid. canceling: canceled at the end of the period. past_due: a payment failed less than 7 days ago. lapsed: a payment failed more than 7 days ago, or the subscription is paused. expired: ended. revoked: a full refund or a chargeback. abandoned: ended before its first payment. The role is held while active, canceling, or past_due.

string
Allowed values: pending active canceling past_due lapsed expired revoked abandoned
plan_id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
plan_name
required
string
interval
required

How often a subscription renews.

string
Allowed values: month year
price
required

Schema: Money

object
period_ends_at

The end of the current period; omitted for pending and abandoned.

string format: date-time
grace_ends_at

When a past_due subscription loses its role.

string format: date-time
scheduled_plan_id

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
scheduled_interval

How often a subscription renews.

string
Allowed values: month year
account_id

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
username

The subscriber’s username; omitted with account_id for an erased account.

string
started_at
required
string format: date-time

Example generated

{
"next_cursor": "example",
"items": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"state": "pending",
"plan_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"plan_name": "example",
"interval": "month",
"price": {},
"period_ends_at": "2026-04-15T12:00:00Z",
"grace_ends_at": "2026-04-15T12:00:00Z",
"scheduled_plan_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"scheduled_interval": "month",
"account_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"username": "example",
"started_at": "2026-04-15T12:00:00Z"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site