BillingWorkflowPaymentChargeAutomaticallySettings

object

Payment settings for a billing workflow when the collection method is charge automatically.

collection_methodstringrequired

The collection method for the invoice.

Allowed values:charge_automatically

Example

BillingWorkflowPaymentSendInvoiceSettings

object

Payment settings for a billing workflow when the collection method is send invoice.

collection_methodstringrequired

The collection method for the invoice.

Allowed values:send_invoice

due_afterstring(ISO8601)

The period after which the invoice is due.
With some payment solutions it’s only applicable for manual collection method.

Default:P30D

Example:P30D

Example

CreateBillingProfileRequest

object

BillingProfile create request.

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"}

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

CreateCustomerRequest

object

Customer create request.

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"}

keystringrequired

ExternalResourceKey is a unique string that is used to identify a resource in an external system.

>= 1 characters<= 256 characters

Example:019ae40f-4258-7f15-9491-842f42a7d6ac

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters
Example

CreateMeterRequest

object

Meter create request.

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"}

keystringrequired

A key is a unique string that is used to identify a resource.

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

>= 1 characters<= 64 characters

Example:resource_key

aggregationstringrequired

The aggregation type to use for the meter.

Allowed values:sumcountunique_countavgminmaxlatest

event_typestringrequired

The event type to include in the aggregation.

>= 1 characters

Example:prompt

events_fromstring(date-time)

The date since the meter should include events.
Useful to skip old events.
If not specified, all historical events are included.

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

value_propertystring

JSONPath expression to extract the value from the ingested event’s data property.

The ingested value for sum, avg, min, and max aggregations is a number or a string that can be parsed to a number.

For unique_count aggregation, the ingested value must be a string. For count aggregation the value_property is ignored.

>= 1 characters

Example:$.tokens

dimensionsobject

Named JSONPath expressions to extract the group by values from the event data.

Keys must be unique and consist only alphanumeric and underscore characters.

Example:{"type":"$.type"}

Example