list_subscriptions
Page every subscription the token may see, newest first, with status and plan filters. Read-only.
Page the purchases themselves, the rows GET /v1/subscriptions returns: each subscription's
id, plan, subscriber, payment method, payment status, price, trial end, end date, whether it
was cancelled and when an access code was redeemed — the same row shape
get_subscription answers, which adds the
access grants. list_subscribers lists the people; this lists what they bought.
Read-only. Never mutates anything.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
statusstringoptionalMatch one payment status word; an unknown value is refused naming the accepted list.
plan_idstringoptionalScope to one plan by UUID.
limitintegeroptionalRows per page, 1..100. Defaults to 25.
pageintegeroptionalPage number, from 1.
How it fails
VALIDATION_FAILEDan unknown status word, or a plan_id that is not a UUID.
TOKEN_MISSING_ABILITYtoken lacks project-subscription:view-any.
Arguments
status(optional) — match one payment status:trialing,active,incomplete,expired,past_due,canceled,unpaid,paused,processing,succeeded,capturableorfailed. An unknown word is refused naming the list.plan_id(optional) — scope to one plan by UUID.limit(optional) — rows per page, 1..100, default 25.page(optional) — page number, from 1.
How is this guide?
Last updated on
list_subscription_grants
List the access grants a subscription holds — one per resource and dated window, with the connector, how access was given, where it stands and why it failed if it did.
pause_subscription
Pause an active or trialing subscription — billing stops and the member keeps their place. The reversible alternative to cancelling.