BillKit/DocsConsole
Tenant

Update billing profile

Set your business country, and optionally your VAT number and invoice address.

POST/v1/tenant/billing_profile
Operation update_billing_profile·Scope tenant:write·OpenAPI v1.1.0

Parameters

ParameterDescription
country_codestringrequiredYour business's country, an ISO 3166-1 alpha-2 code such as NL. Upper-cased when stored. At most 2 characters.
address_line1string | nulloptionalFirst line of your invoice address. Send null to clear it. At most 255 characters.
address_line2string | nulloptionalSecond line of your invoice address. Send null to clear it. At most 255 characters.
citystring | nulloptionalCity of your invoice address. Send null to clear it. At most 128 characters.
legal_namestring | nulloptionalYour business's registered legal name, printed on invoices. Send null to clear it. BillKit does not issue its own invoice to you without it. At most 255 characters.
postal_codestring | nulloptionalPostal code of your invoice address. Send null to clear it. At most 32 characters.
registration_numberstring | nulloptionalYour company registration number, printed on invoices. Send null to clear it. At most 64 characters.
vat_idstring | nulloptionalYour VAT registration number. Can be set once: changing or clearing a stored one returns vat_id_locked. Omit to leave it unchanged. At most 64 characters.

Returns

Returns a TenantBillingProfileResponse 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 tenant: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/tenant/billing_profile \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_code":"NL"}'
Request body · every field
{
  "address_line1": "string",
  "address_line2": "string",
  "city": "string",
  "country_code": "NL",
  "legal_name": "Ada Lovelace",
  "postal_code": "string",
  "registration_number": "string",
  "vat_id": "vat_9XKp2vQ1"
}
Response · 200 OK
{
  "address_line1": "string",
  "address_line2": "string",
  "city": "string",
  "country_code": "NL",
  "effective_country_code": "NL",
  "legal_name": "Ada Lovelace",
  "object": "tenant_billing_profile",
  "postal_code": "string",
  "registration_number": "string",
  "tenant_id": "tenant_9XKp2vQ1",
  "vat_id": "vat_9XKp2vQ1"
}