Drop the purchase waiting on a payment. Nothing was charged, and nothing will be.
POST
/billing/purchase/cancel
const url = 'https://api.siteqwality.com/billing/purchase/cancel';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"idempotency_key":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.siteqwality.com/billing/purchase/cancel \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "idempotency_key": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
idempotency_key
required
Client-generated, stable across retries of one cancel.
string format: uuid
Example generated
{ "idempotency_key": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”Waiting purchases dropped
Media type application/json
object
cancelled
required
How many waiting purchases were dropped (0 when a retry finds none left).
integer format: int32
Example generated
{ "cancelled": 1}Missing or invalid authentication
Caller has no billing role
Internal server error