Skip to main content
POST
/
expire-tokens
Expire Tokens
curl --request POST \
  --url https://tokens.shakesco.com/expire-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_ref": "<string>"
}
'
{ "tx_hash": "0xghi789..." }

Documentation Index

Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt

Use this file to discover all available pages before exploring further.

For the complete documentation index, see llms.txt. Expires every token a customer holds after they’ve been inactive for longer than the period you configured on your token. The full balance is returned to your token reserve. Check whether expiry should run first with /is-expired.
This is irreversible. Run it only when you intend to clear the customer’s balance. The 400 Tokens have not expired yet response is the safety net if you call it early.

Request Body

customer_ref
string
required
Your unique identifier for this customer

Response

tx_hash
string
Reference identifier for the expiry
await fetch("https://tokens.shakesco.com/expire-tokens", {
  method: "POST",
  headers: { Authorization: `Bearer ${API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ customer_ref: "customer-123" }),
});
{ "tx_hash": "0xghi789..." }