Retire a subscription

Request#

POST /api/v1/subscriptions/{record}/retire

Requires subscriptions:lifecycle, subscriptions:delete. See token permissions. Every listed permission is required for this endpoint.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json. Send request bodies as JSON with Content-Type: application/json. This workflow write requires Idempotency-Key. Reuse the same key only when retrying the same action.

record is the numeric subscription ID in your token’s organization.

Request body#

Example#

Set ASSETCENTER_API_TOKEN as described in the quick start. Replace example record and option IDs with values from your organization. Set IDEMPOTENCY_KEY to a new UUID for this action; keep it for retries.

curl --request POST "https://my.assetcenter.app/api/v1/subscriptions/123/retire" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data '{"description":"License retired."}'

Response#

201 Created. Illustrative response structure. Event arrays, to-do/space values, and current state depend on the action and the record.

{
  "data": {
    "subscription_id": 123,
    "subscription_event_ids": [
      901
    ],
    "todo": null,
    "state": {
      "status": "retired",
      "billing_type": "purchase",
      "license_count": 10,
      "billing_frequency": "upfront",
      "price_model": "per_license",
      "cost": "12.00",
      "contract_term": null,
      "contract_start_date": null,
      "contract_end_date": null
    }
  }
}

Behavior and constraints#

State changes reject future timestamps (422) and dates preceding newer relevant state changes (409). Omit event_date to use now. Recurring subscriptions must use cancel. Removes all assignments and records removals together with retired status. Final subscriptions accept notes, to-dos, restoration, or deletion.

Errors#

401 means the token is missing, expired, revoked, or not a customer API token. 403 means a required permission or administrator access is missing. 404 means the record or child record is unavailable in this organization. 422 identifies invalid or unsupported input; inspect the errors object when present. 409 indicates a conflicting state or concurrent change; inspect the message and refresh the record before deciding how to proceed. Reusing an idempotency key with a different method, path, or body also returns 409. 429 means a rate limit was reached. See error handling and rate limits.