Skip to main content
POST
/
v1
/
entities.delete
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.entities.delete({
  customerId: "cus_123",
  entityId: "seat_42",
});
{
  "success": true
}

Body Parameters

Response

{
  "success": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2.1
required

Body

application/json
entity_id
string
required

The ID of the entity.

customer_id
string

The ID of the customer.

Response

200 - application/json

OK

success
boolean
required