Resource Key

string

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

SubscriptionPagePaginatedResponse

object

Page paginated response.

dataarray[object]required

Subscription.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

ULID

string

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example

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