Portal Config

Endpointhttps://api.kontorion.eu/v1

Get customer-portal branding

GET

https://api.kontorion.eu/v1

/portal-branding

Returns the org's customer-portal branding configuration. Fields are null when never configured.

Get customer-portal branding › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

Get customer-portal branding › Responses

object · required

Create or replace customer-portal branding

PUT

https://api.kontorion.eu/v1

/portal-branding

Creates or replaces the org's customer-portal branding configuration. All fields are written; send null to clear one.

Create or replace customer-portal branding › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Create or replace customer-portal branding › Request Body

accent_color

string | null

custom_css

string | null

display_name

string | null

favicon_url

string | null

logo_url

string | null

primary_color

string | null

privacy_url

string | null

support_email

string | null

support_url

string | null

terms_url

string | null

Create or replace customer-portal branding › Responses

object · required

PUT/portal-branding

curl --request PUT \
  --url https://api.kontorion.eu/v1/portal-branding \
  --header 'Content-Type: application/json' \
  --data '
{
  "accent_color": "accent_color",
  "custom_css": "custom_css",
  "display_name": "display_name",
  "favicon_url": "favicon_url",
  "logo_url": "logo_url",
  "primary_color": "primary_color",
  "privacy_url": "privacy_url",
  "support_email": "support_email",
  "support_url": "support_url",
  "terms_url": "terms_url"
}
'

shell

Example Request Body

{
  "accent_color": "accent_color",
  "custom_css": "custom_css",
  "display_name": "display_name",
  "favicon_url": "favicon_url",
  "logo_url": "logo_url",
  "primary_color": "primary_color",
  "privacy_url": "privacy_url",
  "support_email": "support_email",
  "support_url": "support_url",
  "terms_url": "terms_url"
}

json

Example Responses

{
  "data": {
    "accent_color": "accent_color",
    "created_at": "2024-08-25T15:00:00Z",
    "custom_css": "custom_css",
    "display_name": "display_name",
    "favicon_url": "favicon_url",
    "logo_url": "logo_url",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "primary_color": "primary_color",
    "privacy_url": "privacy_url",
    "support_email": "support_email",
    "support_url": "support_url",
    "terms_url": "terms_url",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get customer-portal settings

GET

https://api.kontorion.eu/v1

/portal-settings

Returns the org's customer-portal feature toggles (defaults when never configured).

Get customer-portal settings › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get customer-portal settings › Responses

object · required

Create or update customer-portal settings

PUT

https://api.kontorion.eu/v1

/portal-settings

Creates or updates the org's customer-portal feature toggles. Omitted fields keep their stored value (defaults on first save).

Create or update customer-portal settings › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Create or update customer-portal settings › Request Body

allow_add_payment_method

boolean | null

allow_cancel_subscription

boolean | null

allow_invoice_pay

boolean | null

allow_wallet_topup

boolean | null

show_billing_settings

boolean | null

show_invoices

boolean | null

show_payment_methods

boolean | null

show_subscriptions

boolean | null

show_wallets

boolean | null

Create or update customer-portal settings › Responses

object · required

PUT/portal-settings

curl --request PUT \
  --url https://api.kontorion.eu/v1/portal-settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_add_payment_method": true,
  "allow_cancel_subscription": true,
  "allow_invoice_pay": true,
  "allow_wallet_topup": true,
  "show_billing_settings": true,
  "show_invoices": true,
  "show_payment_methods": true,
  "show_subscriptions": true,
  "show_wallets": true
}
'

shell

Example Request Body

{
  "allow_add_payment_method": true,
  "allow_cancel_subscription": true,
  "allow_invoice_pay": true,
  "allow_wallet_topup": true,
  "show_billing_settings": true,
  "show_invoices": true,
  "show_payment_methods": true,
  "show_subscriptions": true,
  "show_wallets": true
}

json

Example Responses

{
  "data": {
    "allow_add_payment_method": true,
    "allow_cancel_subscription": true,
    "allow_invoice_pay": true,
    "allow_wallet_topup": true,
    "created_at": "2024-08-25T15:00:00Z",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "show_billing_settings": true,
    "show_invoices": true,
    "show_payment_methods": true,
    "show_subscriptions": true,
    "show_wallets": true,
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Payments Roles

Get customer-portal branding

GET

https://api.kontorion.eu/v1

/portal-branding

Returns the org's customer-portal branding configuration. Fields are null when never configured.

Get customer-portal branding › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get customer-portal branding › Responses

object · required

Create or replace customer-portal branding

PUT

https://api.kontorion.eu/v1

/portal-branding

Creates or replaces the org's customer-portal branding configuration. All fields are written; send null to clear one.

Create or replace customer-portal branding › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Create or replace customer-portal branding › Request Body

accent_color

string | null

custom_css

string | null

display_name

string | null

favicon_url

string | null

logo_url

string | null

primary_color

string | null

privacy_url

string | null

support_email

string | null

support_url

string | null

terms_url

string | null

Create or replace customer-portal branding › Responses

object · required

Get customer-portal settings

GET

https://api.kontorion.eu/v1

/portal-settings

Returns the org's customer-portal feature toggles (defaults when never configured).

Get customer-portal settings › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get customer-portal settings › Responses

object · required

Create or update customer-portal settings

PUT

https://api.kontorion.eu/v1

/portal-settings

Creates or updates the org's customer-portal feature toggles. Omitted fields keep their stored value (defaults on first save).

Create or update customer-portal settings › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Create or update customer-portal settings › Request Body

allow_add_payment_method

boolean | null

allow_cancel_subscription

boolean | null

allow_invoice_pay

boolean | null

allow_wallet_topup

boolean | null

show_billing_settings

boolean | null

show_invoices

boolean | null

show_payment_methods

boolean | null

show_subscriptions

boolean | null

show_wallets

boolean | null

Create or update customer-portal settings › Responses

object · required