On This Page
REST API

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:

    ADDITIONAL INFORMATION

    • filters
      : Use Lucene query syntax. Only keyword-matching and
      AND
       are supported. Example:
      status:"ACTIVE" AND code:"01" AND id:"21345"
    • offset
      : Page offset number.
    • limit
      : Number of items to be returned. Default is
      20
       and maximum is
      100
      .
  2. Format the endpoint as follows:

    ADDITIONAL INFORMATION

    GET https://
    <url_prefix>
    /rbs/v1/subscriptions

    ADDITIONAL INFORMATION

    Use one of these URL prefixes:
    • Test:
      apitest.cybersource.com
    • Production:
      api.cybersource.com
    • Production in India:
      api.in.cybersource.com
  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.