Subscription

Get All Subscriptions

Fetch all subscriptions associated with your Helio account.

get/v1/subscriptions

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/subscriptions
  • Auth
    HTTP bearer

Query parameters

emailstring

The email address used to set up the subscription.

paylinkstring

The ID of the pay link associated with the subscription.

apiKeystring required

Your API key can be generated on the Helio Dashboard’s settings page.

Response

Successfully retrieved subscription with transactions.

transactionsPaylinkTxWithBaseMeta[] required
idstring required
status'ACTIVE' | 'EXPIRED' required
emailstring required
renewalDatestring required
createdAtstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.