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

Request

Base URL
https://api.useautumn.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/useautumn/apis/autumn-api/docs/v1/plans.delete/post.ts
A function with typed inputs. Its response is checked against the schema.

x-api-versionstring required

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.

{
  "plan_id": "unused_plan"
}

successboolean required

No recorded changes to this operation across all 1 revision of this API.