Activating a Plan

You can activate a plan that has a draft or inactive status and that has never been assigned to any subscriptions.

Follow these steps to activate a plan:

In the endpoint path, include the plan ID that you received when you retrieved a list of plans.

Send the request to the recurring billing endpoint:

ADDITIONAL INFORMATION

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

ADDITIONAL INFORMATION

Use one of these URL prefixes:

Test:

apitest.cybersource.com

Production:

api.cybersource.com

Production in India:

api.in.cybersource.com

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

Successful Response

{
    "_links": {
        "self": {
            "href": "/rbs/v1/plans/1619214189",
            "method": "GET"
        },
        "update": {
            "href": "/rbs/v1/plans/1619214189",
            "method": "PATCH"
        },
        "deactivate": {
            "href": "/rbs/v1/plans/1619214189/deactivate",
            "method": "POST"
        }
    },
    "id": "1619214189",
    "status": "COMPLETED",
    "planInformation": {
        "code": "1619214189",
        "status": "ACTIVE"
    }
}

Error Response

{
    "status": "NOT_FOUND",
    "reason": "INVALID_DATA",
    "message": "One or more fields in the request contains invalid data.",
    "details": [
        {
            "field": "subscriptionInformation.planId",
            "reason": "NOT_FOUND"
        }
    ]
}

Activating a Plan