payments_list_subscriptions
List payment subscriptions from GoHighLevel using filters for contact, entity, date range, or payment mode. Retrieve subscription details including total payments collected to manage billing and track recurring revenue.
Instructions
List Subscriptions
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Subscription id for filtering of subscriptions. | |
| altId | No | AltId is the unique identifier e.g: location id. Defaults to GHL_LOCATION_ID when omitted. | |
| 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 | No | AltType is the type of identifier. Defaults to GHL_LOCATION_ID when omitted. | |
| 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. |