Needs the subscription:read scope.
Call
- Tool:
get_subscription - Scope:
subscription:read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
subscription |
object |
Yes |
{
"type": "object",
"properties": {
"store": {
"type": "string",
"description": "The store to act on."
},
"subscription": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"subscription"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
display_status |
string |
Yes | Its status as people read it: cancelling while it bills and is set to stop. |
next_event |
object or null |
Yes | What happens at the end of its latest paid period, as of the answer; null when nothing is ahead. |
actions |
object |
Yes | The moves the store offers on it as of the answer; a write still decides again. |
period_end |
string or null |
Yes | When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid. |
customer |
object or null |
Yes | |
product |
object or null |
Yes | |
plan |
object or null |
Yes | |
periods |
object |
Yes | |
scheduled_change |
object or null |
Yes | The plan it renews on from effective_at, the end of its paid run, as the customer scheduled; null for none. |
id |
string |
Yes | |
customer_id |
string |
Yes | |
product_id |
string |
Yes | |
plan_id |
string |
Yes | |
processor |
string or null |
Yes | |
external_ref |
string or null |
Yes | |
account_ref |
string or null |
Yes | |
status |
string |
Yes | |
cancel_at_period_end |
boolean |
Yes | |
instrument_ref |
string or null |
Yes | |
cancel_reason |
string or null |
Yes | |
created_at |
string or null |
Yes | |
ended_at |
string or null |
Yes |
The answer’s full shape is on its API reference page.
Errors
A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:
invalid: an argument is malformed;context.pathnames it.invalidat["store"]:storeis missing while the connection reaches more than one store, or names a store it doesn’t reach.not_found: nothing matches a reference given.not_permitted: this connection may not make this call. Whencontext.reasonislimit, too many calls:retry_aftersays when to try again.internalorunavailable: the call failed inside Sherpo. A read markedtransientmay be retried.client-fault: the server failed around the call.reached_coresays whether it reached Sherpo; the call may be made again.- HTTP 403 with
insufficient_scope: the connection lacks the scope this tool needs. - HTTP 401 with
invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.
Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.