On This Page

Suspending a Subscription

You can suspend a pending, active, or delinquent subscription. Subscriptions cannot be suspended 10 minutes before or after a payment begins processing.

Follow these steps to suspend a subscription:

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

Send the request to the recurring billing endpoint:

Test:

POST https://apitest.merchant-services.bankofamerica.com/rbs/v1/subscriptions/{id}/suspend

Production:

POST https://api.merchant-services.bankofamerica.com/rbs/v1/subscriptions/{id}/suspend

AFTER COMPLETING THE TASK

For more details, see the Suspend a Subscription section of the interactive API Reference.

REST Examples: Suspending a Subscription

Response to a Successful Request

{
    "_links": {
        "self": {
            "href": "/rbs/v1/subscriptions/6192112872526176101960",
            "method": "GET"
        },
        "update": {
            "href": "/rbs/v1/subscriptions/6192112872526176101960",
            "method": "PATCH"
        },
        "cancel": {
            "href": "/rbs/v1/subscriptions/6192112872526176101960/cancel",
            "method": "POST"
        },
        "suspend": {
            "href": "/rbs/v1/subscriptions/6192112872526176101960/suspend",
            "method": "POST"
        }
    },
    "id": "6192112872526176101960",
    "status": "ACCEPTED",
    "subscriptionInformation": {
        "code": "AWC-44",
        "status": "ACTIVE"
    }
}

Response to an Unsuccessful Request

{
    "status": "NOT_FOUND",
    "reason": "INVALID_DATA",
    "details": []
}