POST
/api/products/{productId}/plans/{id}/archive
const url = 'https://example.com/api/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive \ --header 'Authorization: Bearer <token>'Soft-archives the plan: flips IsActive and IsPublic to false. Existing subscriptions keep running; the plan disappears from the onboarding wizard and can’t be picked for new ones. Use this instead of Delete unless you really want a permanent remove.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” productId
required
string format: uuid
The parent product’s identifier.
id
required
string format: uuid
The plan’s unique identifier.
Responses
Section titled “ Responses ”Plan archived (or already archived).
No plan with the given ID exists under this product.
Media type application/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}