BillKit/Docs Console
Tenant

Update portal branding

Set the business name, logo, support email and colours your customers see in the billing portal.

POST/v1/tenant/portal_branding
Operation update_portal_branding · Scope tenant:write · Spec snapshot 2026-09-13

Parameters

ParameterDescription
business_namestring | nulloptionalAt most 255 characters.
capabilitiesobject | nulloptionalNo description in the spec.
logo_urlstring (uri) | nulloptionalMust be an absolute URL. At most 2083 characters.
support_emailstring (email) | nulloptionalMust be a valid email address.
themeobject | nulloptionalNo description in the spec.

Returns

Returns a TenantPortalBrandingResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the tenant:write scope.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl 
curl -X POST https://api.billkit.eu/v1/tenant/portal_branding \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Request body · every field 
{
  "business_name": "Ada Lovelace",
  "capabilities": {
    "checkout_header": false,
    "coupons": false,
    "cycle_enabled": false,
    "invoice_pdf": false,
    "powered_by": false,
    "show_features": false
  },
  "logo_url": "https://acme.example/welcome",
  "support_email": "ada@example.com",
  "theme": {
    "display": "string",
    "font": "string",
    "on_primary": "string",
    "palette": "studio",
    "powered_by": false,
    "primary": "string",
    "primary_100": "string",
    "primary_50": "string",
    "primary_600": "string",
    "radius": 0,
    "stub_a": "string",
    "stub_b": "string"
  }
}
Response · 200 OK 
{
  "business_name": "Ada Lovelace",
  "capabilities": {
    "checkout_header": false,
    "coupons": false,
    "cycle_enabled": false,
    "invoice_pdf": false,
    "powered_by": false,
    "show_features": false
  },
  "effective_business_name": "",
  "effective_support_email": "",
  "logo_url": "https://acme.example/welcome",
  "object": "tenant_portal_branding",
  "support_email": "ada@example.com",
  "theme": {
    "display": "string",
    "font": "string",
    "on_primary": "string",
    "palette": "studio",
    "powered_by": false,
    "primary": "string",
    "primary_100": "string",
    "primary_50": "string",
    "primary_600": "string",
    "radius": 0,
    "stub_a": "string",
    "stub_b": "string"
  }
}