get_subscription
Retrieve a single subscription by ID from your Checkout Page account. Pass livemode: false to read test-mode records.
Use list_subscriptions first if you need to discover a subscription ID by customer email, customer name, product title, or order ID.
If the subscription ID does not exist for the authenticated seller, returns a 404 error: "Subscription not found".
Example uses:
"Fetch subscription 6812fe6e9f39b6760576f01c"
"Show me the full state of this subscription"
"What's the current period end on this subscription?"
This tool is read-only. Cancellation and refund operations must be performed in the Checkout Page dashboard. For cancellation context, use prepare_subscription_cancellation to see eligibility, side effects, and a dashboard link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| livemode | No | Set to false to read test-mode records (created while a page was in test mode). Defaults to live records. | |
| subscriptionId | Yes | The ID of the subscription to retrieve. Use `list_subscriptions` first if you need to discover the subscription ID by email, name, customer, page, or date range. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |