UpsertAppCustomerDataRequest

object

AppCustomerData upsert request.

stripeobject

Used if the customer has a linked Stripe app.

Show Child Parameters
external_invoicingobject

Used if the customer has a linked external invoicing app.

Show Child Parameters
Example

UpsertBillingProfileRequest

object

BillingProfile upsert 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
defaultbooleanrequired

Whether this is the default profile.

Example

UpsertCustomerBillingDataRequest

object

CustomerBillingData upsert request.

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

UpsertCustomerRequest

object

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

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

UsageAttributionSubjectKey

string

Subject key.

>= 1 characters