v1
latestOpenAPI 3.0.02026-07-2671142187.3 KBSubscriptions
Get subscription
Query a subscription by id
get/subscriptions/{subscriptionId}
Path parameters
subscriptionIdinteger required
The subscription id
Query parameters
includeSubObjectsboolean
Specifies whether to include available sub-objects linked to the subscription. Available sub-objects:
- payments tracking the subscription's recurring billing
- add-ons applied to the subscription
Headers
api-tokenstring required
Your API access token for authentication and access to the Helcim API
Response
Successful subscription query. The response body contains the data representation of the queried subscription and (if requested) any sub-objects.