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
The ID of a resource, a UUIDv7 in its canonical string form.
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.
The ID of a resource, a UUIDv7 in its canonical string form.
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.
How often a subscription renews.
Schema: Money
object
The end of the current period: when it renews, or, while canceling, when it ends;
omitted for pending.
When a past_due subscription loses the plan’s role unless a payment succeeds.
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.
Schema: SupporterScheduledChange
object
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