Retrieve one subscription
get_subscriptionRetrieve a customer's ProAbono subscription, including its state, dates, and features, by customer reference. Optionally specify subscription_id or offer_ref to narrow to a particular subscription.
Instructions
Retrieves one ProAbono subscription of a customer, with its state, its dates and the Features it carries. Read-only. The customer reference is required: the Live API has no retrieve-by-identifier operation for subscriptions, so a subscription is always reached through the customer who holds it. Pass subscription_id as well when the customer has several and a specific one is meant; without it, the customer's current subscription comes back. Use list_subscriptions to see them all.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customer_ref": "<customer_ref>"
},
"name": "get_subscription"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offer_ref | No | Narrow to the customer's subscription on this offer reference. | |
| customer_ref | Yes | Shared reference of the customer holding the subscription. | |
| subscription_id | No | Narrow to this subscription of the customer, by internal identifier (Id). |