v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
entities

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.

post/v1/entities.delete

Headers

x-api-versionstring required

Request body

customer_idstring

The ID of the customer.

entity_idstring required

The ID of the entity.

Example request

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

Response

OK

successboolean required

Example response

{
  "success": true
}