ghl_payment_subscription_get
Retrieve a specific subscription's details by subscription ID and location identifier. Fetch single subscription information for payment lookups.
Instructions
Get Subscription by ID The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID. Endpoint: GET /payments/subscriptions/{subscriptionId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.readonly
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": {
"subscriptionId": "<subscriptionId>",
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_payment_subscription_get"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | AltId is the unique identifier e.g: location id. | |
| altType | Yes | AltType is the type of identifier. | |
| subscriptionId | Yes | ID of the subscription that needs to be returned |