HUhub2
Subscriptions

Retrieve a Subscription collection

Changed on
get/subscriptions

Request

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

Query parameters

customerIdstring

Exact match on the merchant customer reference.

billingMode'rbs_scheduled' | 'merchant_initiated'
status'created' | 'pending' | 'active' | 'delinquent' | 'suspended' | 'cancelled' | 'completed'
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

Subscription identifier — pass this into the cancel/suspend/charge/transactions endpoints.

cybersourceSubscriptionIdobject nullable required

Same value received as subscriptionId in the subscription.created webhook payload. Null for a merchant_initiated subscription — there is no RBS-side subscription.

status'created' | 'pending' | 'active' | 'delinquent' | 'suspended' | 'cancelled' | 'completed' required
billingMode'rbs_scheduled' | 'merchant_initiated' required

rbs_scheduled — debited on a schedule by Cybersource RBS; merchant_initiated — charged on demand via POST /subscriptions/{id}/charge.

frequency'weekly' | 'monthly' nullable required

Null for a merchant_initiated subscription — charges are on-demand, not scheduled.

amountobject nullable required

Null for a merchant_initiated subscription — charge amounts are per-call, not fixed.

currencystring required
startDateobject nullable required

Null for a merchant_initiated subscription.

customerIdstring required
createdAtstring date-time required

Changes