ghl_payment_subscription_list
Retrieves a paginated list of subscriptions, filterable by name, status, date range, contact, and other criteria for targeted payment subscription review.
Instructions
List Subscriptions The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information. Endpoint: GET /payments/subscriptions (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.readonly Pagination params: limit, offset — pass them to page through full result sets.
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": {
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_payment_subscription_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Subscription id for filtering of subscriptions. | |
| altId | Yes | AltId is the unique identifier e.g: location id. | |
| endAt | No | Closing interval of subscriptions. | |
| limit | No | The maximum number of items to be included in a single page of results | |
| offset | No | The starting index of the page, indicating the position from which the results should be retrieved. | |
| search | No | The name of the subscription for searching. | |
| altType | Yes | AltType is the type of identifier. | |
| startAt | No | Starting interval of subscriptions. | |
| entityId | No | Entity id for filtering of subscriptions. | |
| contactId | No | Contact ID for the subscription | |
| paymentMode | No | Mode of payment. | |
| entitySourceType | No | Source of the subscriptions. | |
| getPaymentsCollectedCount | No | Get the total payments collected for the subscription. |