entities

POST /v1/entities.delete

Deletes an entity by entity ID.

Use this when the underlying resource is removed and you no longer want entity-scoped balances or subscriptions tracked for it.

Request

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

x-api-versionstring required

customer_idstring

The ID of the customer.

entity_idstring required

The ID of the entity.

{
  "customer_id": "cus_123",
  "entity_id": "seat_42"
}

successboolean required

{
  "success": true
}

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