Skip to content

BillKit/DocsConsole

Customers

Purge customer

Erase a customer's personal data and keep their financial history.

POST/v1/customers/{customer_id}/purge

Operation purge_customer·Scope customers:write·OpenAPI v1.1.0

Parameters

Parameter	Description
customer_idstring · pathrequired	Id of the customer, which starts `cus_`.
confirmedbooleanoptional	Must be true, confirming that the erasure is intended. It cannot be undone. Defaults to `false`.

Returns

Returns a PurgedResource object.

Errors

Status	Cause
400	The request was refused (`type: invalid_request_error`): a required parameter is missing (`parameter_missing`), one failed validation (`parameter_invalid`) or is not one the operation takes (`parameter_unknown`), and `param` names it.
401	No credential, or one that does not authenticate.
402	The account is suspended (`tenant_suspended`), or the payment provider refused a charge or refund the call made (`type: payment_error`, `code: payment_refused`).
403	Authenticated, but not allowed: missing scope (`insufficient_scope`), a key of the wrong mode (`mode_mismatch`), or a refused origin. Needs the `customers:write` scope.
404	No such object in this account and mode.
409	Conflicts with the object's current state (`state_conflict`, or a more specific code), or an operation still in flight (`operation_pending`).
413	The request body is larger than the API accepts.
429	Rate limited. `Retry-After` says when to try again.
500	Something failed on BillKit's side (`type: api_error`). Retry with the same `Idempotency-Key`.
502	The payment provider failed or did not answer.
503	Temporarily unable to serve. `reason` says whether the request was attempted.

List customers GET /v1/customers
Create a customer POST /v1/customers
Delete customer DELETE /v1/customers/{customer_id}
Retrieve a customer GET /v1/customers/{customer_id}
Update customer POST /v1/customers/{customer_id}
Set customer VAT number POST /v1/customers/{customer_id}/vat_number

Request · curl

curl -X POST https://api.billkit.eu/v1/customers/cus_9XKp2vQ1/purge \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmed":true}'

curl -X POST https://api.billkit.eu/v1/customers/cus_9XKp2vQ1/purge \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmed":true}'

Request body · every field

{
  "confirmed": false
}

{
  "confirmed": false
}

Response · 200 OK

{
  "deleted": true,
  "id": "obj_9XKp2vQ1",
  "object": "string",
  "purged": true
}

{
  "deleted": true,
  "id": "obj_9XKp2vQ1",
  "object": "string",
  "purged": true
}