Retrieving a List of Plans

A list of plans provides these details for each plan:
  • Plan ID
  • Plan code
  • Plan name
  • Description
  • Status
  • Billing period unit
  • Billing period length
  • Billing cycles total
  • Currency
  • Billing amount
  • Set-up fee
After you retrieve the list of plans, use the plan ID to retrieve, amend, activate, deactivate, or delete a subscription.
Follow these steps to retrieve a list of plans:
  1. Filter the list of plans using these query string parameters:

    ADDITIONAL INFORMATION

    • filters
      : Use Lucene query syntax. Only keyword-matching and
      AND
      are supported. Example:
      name:"Test plan" AND code:"009" AND status:"ACTIVE"
    • offset
      : Page offset number.
    • limit
      : Number of items to be returned. Default is
      20
      and maximum is
      100
      .
  2. Send to one of these endpoints:

    ADDITIONAL INFORMATION

    Production:
    GET https://api.cybersource.com/rbs/v1/plans
    Test:
    GET https://apitest.cybersource.test.com/rbs/v1/plans
  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
    .

REST Example: Retrieving a List of Plans

Light Dark
Response to a Successful Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
{"_links": { "self": { "href": "/rbs/v1/plans?limit=2", "method": "GET" }, "next": { "href": "/rbs/v1/plans?offset=2&limit=2", "method": "GET" } }, "totalCount": 96, "plans": [ { "_links": { "self": { "href": "/rbs/v1/plans/1619212820", "method": "GET" }, "update": { "href": "/rbs/v1/plans/1619212820", "method": "PATCH" }, "deactivate": { "href": "/rbs/v1/plans/1619212820/deactivate", "method": "POST" } }, "id": "1619212820", "planInformation": { "code": "1619310018", "status": "ACTIVE", "name": "Test plan", "description": "Description", "billingPeriod": { "length": "1", "unit": "W" }, "billingCycles": { "total": "4" } }, "orderInformation": { "amountDetails": { "currency": "USD", "billingAmount": "7.00", "setupFee": "0.00" } } }, { "_links": { "self": { "href": "/rbs/v1/plans/6183561970436023701960", "method": "GET" }, "update": { "href": "/rbs/v1/plans/6183561970436023701960", "method": "PATCH" }, "activate": { "href": "/rbs/v1/plans/6183561970436023701960/activate", "method": "POST" } }, "id": "6183561970436023701960", "planInformation": { "code": "1616024773", "status": "DRAFT", "name": "Plan Test", "description": "12123", "billingPeriod": { "length": "9999", "unit": "Y" }, "billingCycles": { "total": "123" } }, "orderInformation": { "amountDetails": { "currency": "USD", "billingAmount": "1.00", "setupFee": "0.00" } } } ]}
Error Response
123456789
{"status": "INVALID_REQUEST", "reason": "VALIDATION_ERROR", "message": "Field validation errors.", "details": [ { "field": "customerInformation.email", "reason": "Invalid email" } ]}