List billing profiles
List billing profiles.
Query Parameters
Determines which page of the collection to retrieve.
Show Child Parameters
Response
application/json
Response
Page paginated response.
BillingProfilePagePaginatedResponse
Page paginated response.
Billing profiles contain the settings for billing and controls invoice generation.
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Query Parameters
Create a new billing profile
Create a new billing profile.
Billing profiles contain the settings for billing and controls invoice generation.
An organization can have multiple billing profiles defined.
A billing profile is linked to a specific app. This association is established during the billing profile’s creation and remains immutable.
Body
application/json
Body
CreateBillingProfileRequest
BillingProfile create request.
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"}
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.
Response
application/json
Response
BillingProfile created response.
BillingProfile
Billing 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.
Authentication
Body
Get a billing profile
Get a billing profile.
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
application/json
Response
BillingProfile response.
BillingProfile
Billing 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.
Authentication
Path Parameters
Update a billing profile
Update a billing profile.
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
UpsertBillingProfileRequest
BillingProfile upsert request.
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"}
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
Whether this is the default profile.
Response
application/json
Response
BillingProfile updated response.
BillingProfile
Billing 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.
Authentication
Path Parameters
Body
Delete a billing profile
Delete a billing profile.
Only such billing profiles can be deleted that are:
- not the default profile
- not pinned to any customer using customer overrides
- only have finalized invoices
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
Response
Deleted response.