Deactivating a Plan

You can deactivate a specific plan that has an active status.
Follow these steps to deactivate 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

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

    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: Deactivating a Plan

Successful Response
{
    "_links": {
        "self": {
            "href": "/rbs/v1/plans/1619214189",
            "method": "GET"
        },
        "activate": {
            "href": "/rbs/v1/plans/1619214189/activate",
            "method": "POST"
        }
    },
    "id": "1619214189",
    "status": "COMPLETED",
    "planInformation": {
        "code": "1619214189",
        "status": "INACTIVE"
    }
}
Error Response
{
    "status": "INVALID_REQUEST",
    "reason": "INVALID_DATA",
    "message": "One or more fields in the request contains invalid data.",
    "details": [
        {
            "field": "planInformation.status",
            "reason": "INVALID_DATA"
        }
    ]
}
Deactivating a Plan