Delete Rate Plan API

Delete a rate plan

delete

/rate_plans/{id}

Delete a rate plan by its identifier. A rate plan mapped to a channel is refused with 422 Unprocessable Entity unless force=true is sent. Rate plans derived from it (those with it as parent_rate_plan_id) are deleted with it.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Path parameters

idstring · uuidRequiredExample: 716305c4-561a-4561-a187-7f5b8aeb5920

Query parameters

forcebooleanOptional

Delete the rate plan even when it is mapped to a channel: the mappings are removed with it and the channel notified. Without it the request fails when channel mappings would be affected. Irreversible: neither the rate plan nor its channel information can be restored.

Responses

200

The request has succeeded.

application/json

Success response carrying only a meta message (no resource body).

401

Authentication credentials are missing or invalid.

application/json

404

The requested resource does not exist.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

delete/rate_plans/{id}

DELETE /api/v1/rate_plans/{id} HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "message": "Success"
  }
}