Subscriptions

Retrieve a subscription's charge history

Changed on
get/subscriptions/{id}/transactions

Request

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

Path parameters

idnumber required

Query parameters

pagenumber
Example:2

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

perPagenumber
Example:5

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

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

idnumber required
amountstring required

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

status'pending' | 'success' | 'failed' required
transactionDatestring date-time required
cybersourceReferenceobject nullable required

Null while a merchant_initiated charge is still pending confirmation from Cybersource.

merchantReferenceobject nullable required

Reference sent when triggering an on-demand charge. Null for scheduled RBS debits.

indicator'CIT' | 'MIT' required

Changes