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

const autumn = new Autumn()

const result = await autumn.keys.revoke({
  customerId: "cus_123",
});
{
  "revoked": true
}
Revokes every outstanding token — access and refresh — for a customer. Authenticated with your secret key. Issue new tokens afterwards with keys.mint.
await autumn.keys.revoke({ customerId: "cus_123" });

Body Parameters

Response

{
  "revoked": 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.3.0
required

Body

application/json
customer_id
string
required

The customer whose tokens (every outstanding access + refresh token) should be revoked.

Response

200 - application/json

OK

revoked
any
required