Delete plan (Usage-Based only)

Overview

Deletes a partner-managed usage-based plan and removes its plans link to the partner.

Prerequisites

• A bearer token. Callable with Partner tokens.
• The planId of the record you are targeting.

Base URL

Endpoint

DELETE /api/v1/partner/plans/{planId}

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.
• Who can call it: Partner tokens.

Validation rules:

• Usage-based, partner-managed plans only.
• Returns 403 in any of these cases. No authenticated partner is found, the plan is not usage-based or is admin-managed, the plan is not linked to the partner, or the caller is a sub-partner.
• Returns 422 if the plan ID is invalid or doesn't exist.

Rate limit

• No rate limit.

Path parameters

Path parameters

Response

200 OK · 200

{ "data": { "message": "Plan deleted." } }

Errors

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/plans/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'