HEhel
Subscription

Get a Subscription by ID

Retrieve the details of a specific subscription by its ID.

get/v1/subscriptions/{id}

Request

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

Path parameters

idstring required

The ID of the specific subscription. You can retrieve this ID using the /v1/subscriptions endpoint.

Query parameters

apiKeystring required

API key can be generated on helio dashboard 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.