Subscriptions API

A subscription is one member's purchase of one plan: the row that says who bought what, on which payment method, for how much, and until when. Every checkout on the portal or in the bot, every redeemed access code and every cardless trial creates one, so there is no POST here: a subscription comes into being when a member pays or redeems, and these endpoints let you read it, follow the access it granted and drive the rest of its life.

The row carries a payment_status that tracks the provider's view of the money (trialing, active, past_due, paused, canceled, expired and the rest), an ends_at that already includes any outage compensation the member was owed, and, when read individually, its grants: the access ledger with one row per resource the plan unlocks, and per dated window for a pass. A grant says which connector admitted the member, how (bearer_link, membership, role or creator_task), where it stands (pending_identity, pending, held, granted, revoked or failed) and why when it failed. Read the grants, not the payment status, to know whether a member is actually inside the channel.

The lifecycle endpoints are RPC-style actions rather than field edits, because each one talks to a payment provider or a connector on the way: cancel queues the provider-side cancellation and answers 202; pause and unpause suspend and restore access while billing continues; reactivate calls off a scheduled cancellation, on Stripe only, since the other providers end the agreement outright; reissue revokes the member's invite links and mints fresh ones; and remind re-sends a pass holder the links they have not used yet. Every transition announces itself as a subscription.* event. Subscriptions are read across every project the token reaches, a scope:project token sees only its projects, and a subscription of any other project is a 404 on every endpoint here.

EndpointsCopy Anchor Link

Related

Members APIMembers are the project-scoped subscribers.Plans APIA plan is what a project sells: the price, the currency, the billing cycle or the dated windows, the eligibility rules and the resources a purchase unlocks.Pass Windows APINudge every holder of one window at once.Webhook Events APIA read-only polling endpoint that surfaces the most recent webhook deliveries for a given event type.subscription.* eventsEvery transition these endpoints and the payment providers announce.