Suspend subscription
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Any subscribers who have a seat entitled to the subscription are suspended. However, any seat that is assigned to subscribers of the subscription remain in the assigned state.

The API caller must have the VSR role to run the API.

Table 1. API details
Method
Resource address
Operation header
POST
/resource/subscription/<id>
x-operation: suspendSubscription


URL parameters


Provide the following parameter.

Table 2. Parameters
Parameter
Required
Description
id
Yes
The ID of the subscription that needs to be suspended.

To verify that the subscription is suspended, see the Get subscription by ID topic for details about performing a GET operation.

For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Subscription management services
Input
Method URI Description
POST /api/bss/resource/subscription/{id} Suspend a subscription and its child subscriptions for a registered customer.
The API caller must have the VSR role to run the API.
Content Type: text/plain
Name Type Optional Description
id
string No The ID of the subscription that needs to be suspended.
Name Type Optional Description
x-operation
string Yes x-operation: suspendSubscription