Retrieving a Plan

You can retrieve the details of a specific plan using the plan ID. The plan details returned in the response include:
  • Plan ID
  • Plan code
  • Plan name
  • Description
  • Status
  • Billing period unit
  • Billing period length
  • Billing cycles total
  • Currency
  • Billing amount
  • Set-up fee
Follow these steps to retrieve a plan:
  1. In the endpoint path, include the plan ID that you received when you retrieved a list of plans.
  2. Send the request to the recurring billing endpoint:

    ADDITIONAL INFORMATION

    GET https://<
    url_prefix
    >/rbs/v1/plans/{id}

    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.

REST Examples: Retrieving a Plan

Successful Response
{
    "_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
{
  "status": "NOT_FOUND",
  "reason": "INVALID_DATA"
}
Retrieving a Plan