BillKit/DocsConsole
API keys

Create API key

Issue a new API key.

POST/v1/api_keys
Operation create_api_key·Scope api_keys:write·OpenAPI v1.1.0

Parameters

ParameterDescription
labelstring | nulloptionalA name for the key, shown in the console and on this object. At most 255 characters.
scopesarray of string | nulloptionalThe scopes the new key carries, such as customers:read, or * for every scope. Omit to give it the calling key's scopes. Each must be a known scope the calling key holds.

Returns

Returns an ApiKeyResponse 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 api_keys: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 POST https://api.billkit.eu/v1/api_keys \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Request body · every field
{
  "label": "string",
  "scopes": [
    "string"
  ]
}
Response · 200 OK
{
  "created": 1789392000,
  "id": "ak_4b2a1e907c3d4f189a551c0b6de3a742",
  "label": "string",
  "last_used_at": 1789392000,
  "livemode": false,
  "object": "api_key",
  "prefix": "string",
  "revoked_at": 1789392000,
  "scopes": [
    "string"
  ],
  "secret": "string"
}