Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.entities.delete({
customerId: "cus_123",
entityId: "seat_42",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.entities.delete(
entity_id="seat_42",
customer_id="cus_123",
)curl --request POST \
--url https://api.useautumn.com/v1/entities.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"entity_id": "seat_42"
}
'{
"success": true
}
Entities
Delete Entity
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
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.entities.delete({
customerId: "cus_123",
entityId: "seat_42",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.entities.delete(
entity_id="seat_42",
customer_id="cus_123",
)curl --request POST \
--url https://api.useautumn.com/v1/entities.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"entity_id": "seat_42"
}
'{
"success": true
}
Body Parameters
Response
{
"success": true
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
200 - application/json
OK