Set plan definition as unavailable

This POST operation sets a plan definition as being unavailable. Being unavailable just means that it cannot be purchased or provisioned. If successful, you receive an HTTP response code of 204. See HTTP response codes for other response codes.

POST /pcc/spcm/planDefinitions/<planDefinitionId>/make-unavailable

HEADER INFO

tenant: <tenantName>

authorisation: HTTP Basic Auth

permissions: SPCM_PLAN_DEFINITION_UPDATE_PERMISSION

URL parameters

There is one mandatory parameter.

Parameter Type Description

Parameter	Type	Description
`planDefinitionId`	integer	A unique identifier for a plan definition which was assigned by the server upon creating the plan definition.

planDefinitionId

integer

A unique identifier for a plan definition which was assigned by the server upon creating the plan definition.

HTTP response codes

Code Description

201/204

success!

If you receive a 204 code, you will not see a JSON response.

207

Multistatus response

Check out HTTP statuses for more details.

This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

plan definition not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.

This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example

HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example

HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

500

internal error

example

HTTP/1.1 500
{
    "message": "Internal server error - [Failed to get session information]",
    "status": "error"
}

503

request rejected due to overload