Get Subscriptions
The following endpoint can be used to retrieve the details of Subscriptions within the Halo Pay Link application.
Endpoint
The following endpoint can be used to retrieve Subscriptions. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/subscriptions?updated_after={updated_after}
Request Query Parameters
Field
Type
Description
updated_after
Date
A timestamp to be used as the start of the date range (exclusive) of the query. On subsequent requests, you should pass in the nextUpdatedAfter value that was in the response of the previous request. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Response
Field
Type
Description
recordsMatched
Number
The number of records that matched the query parameters.
recordsReturned
Number
The number of records that were returned.
nextUpdatedAfter
Date
A timestamp to be used as the start of the date range (exclusive) of the next query for the same endpoint. This is used for pagination when querying with an updated_after parameter. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
records
The list of contacts that matched the query parameters.