BillingEntitlementAccessResult
objectEntitlement access result.
The type of the entitlement.
Allowed values:meteredstaticboolean
Example:static
The feature key of the entitlement.
Match pattern:^[a-z0-9]+(?:_[a-z0-9]+)*$
>= 1 characters<= 64 characters
Example:available_models
Whether the customer has access to the feature.
Always true for boolean and static entitlements.
Depends on balance for metered entitlements.
Example:true
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"] }
BillingProfile
objectBilling profiles contain the settings for billing and controls invoice generation.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Display name of the resource.
Between 1 and 256 characters.
>= 1 characters<= 256 characters
Optional description of the resource.
Maximum 1024 characters.
<= 1024 characters
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity last update date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity deletion date.
Example:2023-01-01T01:01:01.001Z
The name and contact information for the supplier this billing profile represents
Show Child Parameters
The billing workflow settings for this profile
Show Child Parameters
The applications used by this billing profile.
Show Child Parameters
Whether this is the default profile.
BillingProfilePagePaginatedResponse
objectPage paginated response.
Billing profiles contain the settings for billing and controls invoice generation.
Show Child Parameters
returns the pagination information
Show Child Parameters
BillingSubscription
objectSubscription.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity last update date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity deletion date.
Example:2023-01-01T01:01:01.001Z
The customer ID of the subscription.
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The plan ID of the subscription.
Set if subscription is created from a plan.
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
A billing anchor is the fixed point in time that determines the subscription’s recurring billing cycle.
It affects when charges occur and how prorations are calculated.
Common anchors:
- Calendar month (1st of each month):
2025-01-01T00:00:00Z - Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
Example:2023-01-01T01:01:01.001Z
The status of the subscription.
Allowed values:activeinactivecanceledscheduled
BillingSubscriptionCancel
objectRequest for canceling a subscription.
One OfIf not provided the subscription is canceled immediately.
Default:immediate
Example:immediate
Subscription edit timing.
When immediate, the requested changes take effect immediately.
When next_billing_cycle, the requested changes take effect at the next billing cycle.
Allowed values:immediatenext_billing_cycle