HUhub2
Subscription Intents

Retrieve a card-on-file enrollment status

Changed on

Resolves how an enrollment ended, at any point after its link was issued — so "the payer abandoned it", "it was refused" and "it broke on our side" are distinguishable. Enrollments created before this endpoint shipped have no attempt record and still answer 404.

get/subscription-intents/{id}/status

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Path parameters

idstring required

Id of the enrollment payment returned by POST /subscription-intents.

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

paymentIdstring required

Id of the underlying enrollment payment, as returned by POST /subscription-intents.

status'successful' | 'failed' | 'pending' | 'action_required' required

"pending" while the enrollment link has been issued but nothing came back yet, "action_required" once the payer has been redirected to the card issuer's page, "successful" once the subscription has actually been recorded, and "failed" when the enrollment was refused or could not be recorded. A payer who never completes the page stays "action_required" — it is never reported as "failed".

subscriptionIdnumber

Present once status is "successful": the subscription id to use with /subscriptions endpoints (charge, cancel, suspend, transactions).

createdAtstring date-time required

When the enrollment link was issued.

updatedAtstring date-time required

When the enrollment last changed state.

Changes