BillingCustomerData

object

Billing customer data.

billing_profileobject

The billing profile for the customer.

If not provided, the default billing profile will be used.

Show Child Parameters
app_dataobject

App customer data.

Show Child Parameters
Example

BillingCustomerStripeCreateCheckoutSessionRequest

object

Request to create a Stripe Checkout Session for the customer.

Checkout Sessions are used to collect payment method information from customers
in a secure, Stripe-hosted interface. This integration uses setup mode to collect
payment methods that can be charged later for subscription billing.

stripe_optionsobjectrequired

Options for configuring the Stripe Checkout Session.

These options are passed directly to Stripe’s checkout session creation API.

Show Child Parameters
Example

BillingCustomerStripeCreateCustomerPortalSessionRequest

object

Request to create a Stripe Customer Portal Session for the customer.

Useful to redirect the customer to the Stripe Customer Portal to manage their payment methods,
change their billing address and access their invoice history.
Only returns URL if the customer billing profile is linked to a stripe app and customer.

stripe_optionsobjectrequired

Options for configuring the Stripe Customer Portal Session.

Show Child Parameters
Example

BillingEntitlementAccessResult

object

Entitlement access result.

typestringrequiredread-only

The type of the entitlement.

Allowed values:meteredstaticboolean

Example:static

feature_keystringrequiredread-only

The feature key of the entitlement.

Match pattern:^[a-z0-9]+(?:_[a-z0-9]+)*$

>= 1 characters<= 64 characters

Example:available_models

has_accessbooleanrequiredread-only

Whether the customer has access to the feature.
Always true for boolean and static entitlements.
Depends on balance for metered entitlements.

Example:true

configstringread-only

Only available for static entitlements.
Config is the JSON parsable configuration of the entitlement.
Useful to describe per customer configuration.

Example:{ "availableModels": ["gpt-5", "gpt-4o"] }

Example

BillingProfile

object

Billing profiles contain the settings for billing and controls invoice generation.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2023-01-01T01:01:01.001Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

Example:2023-01-01T01:01:01.001Z

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

Example:2023-01-01T01:01:01.001Z

supplierobjectrequired

The name and contact information for the supplier this billing profile represents

Show Child Parameters
workflowobjectrequired

The billing workflow settings for this profile

Show Child Parameters
appsobjectrequired

The applications used by this billing profile.

Show Child Parameters
defaultbooleanrequired

Whether this is the default profile.

Example