Skip to content

SupporterSubscription

The authenticated user’s subscription to a supporter plan. price is what it renews at, which may be lower than the plan’s current price (a price change does not apply to the subscriptions that go on). The plan’s name is written by the administrators in any language; render it with dir="auto".

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
plan_rank
required

The plan’s rank, given also for a hidden plan, which the plan list leaves out: a change to a plan of a higher rank applies at once, to a lower one at the end of the period.

integer
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: when it renews, or, while canceling, when it ends; omitted for pending.

string format: date-time
grace_ends_at

When a past_due subscription loses the plan’s role unless a payment succeeds.

string format: date-time
end_reason

Why a lapsed, expired, or revoked subscription lost the plan’s role; omitted in the other states. lapsed: no payment succeeded within 7 days after a payment failed, or the subscription is paused. reversed: a payment was refunded in full or charged back. plan_retired: the administrators retired the plan. account_suspended: the account was suspended. account_closed: the account was deleted. staff: an administrator canceled it. canceled: it was canceled, or it ended at the payment provider.

string
Allowed values: lapsed reversed plan_retired account_suspended account_closed staff canceled
scheduled_change
started_at
required
string format: date-time

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"state": "pending",
"plan_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"plan_name": "example",
"plan_rank": 1,
"interval": "month",
"price": {},
"period_ends_at": "2026-04-15T12:00:00Z",
"grace_ends_at": "2026-04-15T12:00:00Z",
"end_reason": "lapsed",
"scheduled_change": {},
"started_at": "2026-04-15T12:00:00Z"
}

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

Analytics on this site