v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
plans

Delete a plan

Deletes a plan by its ID.

Use this to permanently remove a plan. Plans with active customers cannot be deleted - archive them instead.

post/v1/plans.delete

Headers

x-api-versionstring required

Request body

plan_idstring required

The ID of the plan to delete.

all_versionsboolean

If true, deletes all versions of the plan. Otherwise, only deletes the latest version.

Example request

{
  "plan_id": "unused_plan"
}

Response

OK

successboolean required