HUhub2
Subscriptions

Charge a merchant-initiated subscription on demand

Changed on
post/subscriptions/{id}/charge

Request

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

Path parameters

idnumber required

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.

Request body

amountnumber required

In the smallest currency unit (e.g. 100 cents to charge €1.00).

currencystring required
referencestring required

Your idempotency key — retrying with the same reference and the same amount on the same subscription never charges twice. Retry with the same reference and amount after a timeout or 5xx; the same reference with a different amount is refused with 409.

Response

idnumber required
status'pending' | 'success' | 'failed' required
amountstring required

Decimal string in major currency units, e.g. "1500.00".

transactionDatestring date-time required
cybersourceReferenceobject nullable required

Null while the charge is still pending confirmation from Cybersource.

merchantReferenceobject nullable required

The reference sent when triggering this charge.

indicator'CIT' | 'MIT' required
createdAtstring date-time required

Changes