BillKit/DocsConsole
Test clocks

Delete test clock

Delete a test clock.

DELETE/v1/test_clocks/{test_clock_id}
Operation delete_test_clock·Scope test_clocks:write·OpenAPI v1.1.0

Parameters

ParameterDescription
test_clock_idstring · pathrequiredId of the test clock, which starts tc_.

Returns

Returns a DeletedResource object.

Errors

StatusCause
400The 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.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the test_clocks:write scope.
404No such object in this account and mode.
409Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending).
413The request body is larger than the API accepts.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
502The payment provider failed or did not answer.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X DELETE https://api.billkit.eu/v1/test_clocks/tc_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "deleted": true,
  "id": "obj_9XKp2vQ1",
  "object": "string"
}