BillKit/DocsConsole
Tenant

Get portal branding

Read your billing portal branding.

GET/v1/tenant/portal_branding
Operation get_portal_branding·Scope tenant:read·OpenAPI v1.1.0

Parameters

This endpoint takes no parameters.

Returns

Returns a TenantPortalBrandingResponse 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:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/tenant/portal_branding \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "business_name": "Ada Lovelace",
  "capabilities": {
    "checkout_header": false,
    "coupons": false,
    "customer_country_editable": false,
    "customer_vat_number_editable": 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",
    "primary": "string",
    "primary_100": "string",
    "primary_50": "string",
    "primary_600": "string",
    "radius": 0,
    "stub_a": "string",
    "stub_b": "string"
  }
}