On This Page

Retrieving a List of Subscriptions

You can retrieve a list of subscriptions with these details for each subscription:
  • Subscription ID
  • Subscription code
  • Subscription status
  • Subscription name
  • Customer ID
  • Plan ID
  • Plan code
  • Plan name
  • Plan description
  • Plan status
  • Billing period unit
  • Billing period length
  • Billing cycles total
  • Billing cycles current
  • Currency
  • Billing amount
  • Set-up fee
Use the subscription ID to retrieve, amend, activate, suspend, or cancel an individual subscription.
Follow these steps to retrieve a list of subscriptions:
  1. Filter the list of subscriptions by these query string parameters:
    • planName
      : Name of the plan.
    • customerId
      : Customer token ID.
    • status
      : Subscription status (e.g., ACTIVE, CANCELLED).
    • customerFirstName
      : Customer's first name.
    • customerLastName
      : Customer's last name.
    • code
      : Specific subscription code.
    • plancode
      : Specific plan code.
    • offset
      : Page offset number.
    • limit
      : Number of items to be returned (default is 20, maximum is 100).
  2. Send the request message to one of these endpoints:
    Production:
    GET https://api.cybersource.com/rbs/v1/subscriptions
    Test:
    GET https://apitest.cybersource.test.com/rbs/v1/subscriptions
  3. Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success.
    For information about response codes, see
    Transaction Response Codes
    .