Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.plans.delete({
planId: "unused_plan",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.plans.delete(
plan_id="unused_plan",
all_versions=False,
)curl --request POST \
--url https://api.useautumn.com/v1/plans.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"plan_id": "unused_plan"
}
'{
"success": true
}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
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.plans.delete({
planId: "unused_plan",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.plans.delete(
plan_id="unused_plan",
all_versions=False,
)curl --request POST \
--url https://api.useautumn.com/v1/plans.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"plan_id": "unused_plan"
}
'{
"success": true
}Deletes a plan or a specific version of a plan.
Deleting a plan cannot be undone. Existing subscriptions to this plan will remain active until canceled.
Common Use Cases
await autumn.plans.delete({
planId: "old_plan"
});
await autumn.plans.delete({
planId: "old_plan",
allVersions: true
});
Body Parameters
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
200 - application/json
OK