Update 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

Update a subscription for a registered customer to change the expiration date or the number of available seats. The subscription must be owned by the organization of the authenticated user.
The API caller must have the VSR role to run the API.

Table 1. API details
Method
Resource address
Input representation
PUT
/resource/subscription/<id>
A JavaScript™ Object Notation (JSON) entry that represents a subscription.


URL parameters


Provide the following parameter.

Table 2. URL parameters
Parameter
Required
Description
id
Yes
The ID of the subscription to be updated. To obtain the ID, see the Get subscription list by customer ID topic.


Input attributes


The input attribute must be a well formatted JSON object with following information. You can update only the following two attributes.

Table 3. Attributes
Attribute
Description
ExpirationDate
The date the subscription expires.
NumberOfSeats
The number of service offerings. Note that numberOfSeats must not exceed the value of maxNumberOfSeats.


Note: To retrieve the most current payload information, see the Get subscription by ID topic to perform a GET operation. Then modify the payload you receive and submit it as part of the update.

If the update is successful, nothing is returned. To verify your changes, see the Get subscription by ID topic to perform 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
PUT /api/bss/resource/subscription/{id} Update a subscription for a registered customer to change the expiration date or the number of available seats. The subscription must be owned by the organization of the authenticated user.
The API caller must have the VSR role to run the API.
Content Type: application/json
Use the table below that represents the expected fields:
Name Type Optional Description
ExpirationDate
string No The date the subscription expires.
NumberOfSeats
string No The number of service offerings.
Name Type Optional Description
id
string No he ID of the subscription to be updated.
Output
Content Type: application/json