Suspend subscriber
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

Suspend a subscriber. Suspended subscribers are no longer active and cannot use services to which they are entitled.
The API caller must have either the VSR or CustomerAdministrator role to run the API.

To allow subscriber to reuse services, see the Unsuspend subscriber topic.

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


URL parameters


Provide the following parameter:

Table 2. Parameters
Parameter
Required
Description
id
Yes
The ID of the subscriber. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.

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

Parent topic: Subscriber management services
Input
Method URI Description
POST /api/bss/resource/subscriber/{id} Suspend a subscriber. Suspended subscribers are no longer active and cannot use services to which they are entitled.
The API caller must have either the VSR or CustomerAdministrator role to run the API.
Content Type: text/plain
Name Type Optional Description
id
string Yes The ID of the subscriber.
Name Type Optional Description
x-operation
string No x-operation: suspendSubscriber