Delete or archive a plan

curl --request DELETE \
  --url https://coreapi.io/api/plans/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "archived",
  "references": {
    "checkoutLinks": 123,
    "subscriptions": 123,
    "schedules": 123
  }
}

DELETE

api

plans

{id}

Delete or archive a plan

curl --request DELETE \
  --url https://coreapi.io/api/plans/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "archived",
  "references": {
    "checkoutLinks": 123,
    "subscriptions": 123,
    "schedules": 123
  }
}

Authorization

string

header

erforderlich

Organisation API token. Send it as Authorization: Bearer api_... The token is scoped to a single Organisation.

string<uuid>

erforderlich

The plan UUID.

Beispiel:

"1280792f-4e23-793d-8e9c-3a1bf36630bd"

The plan was archived because it is still referenced.

Returned with status 200 when a plan could not be hard deleted because it is still referenced, and was archived instead.

status

enum<string>

Verfügbare Optionen:

archived

references

object

Show child attributes