BillingCurrency
objectFiat or custom currency.
One OfULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The type of the currency.
Allowed values:fiat
The name of the currency. It should be a human-readable string that represents the name of the currency, such as “US Dollar” or “Euro”.
>= 1 characters<= 256 characters
Description of the currency.
>= 1 characters<= 256 characters
The symbol of the currency. It should be a string that represents the symbol of the currency, such as “$” for US Dollar or “€” for Euro.
>= 1 characters
Three-letter ISO4217 currency code.
Custom three-letter currency codes are also supported for convenience.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
BillingCurrencyCodeCustom
stringCustom currency code.
It should be a unique code but not conflicting with any existing fiat currency codes.
>= 3 characters<= 24 characters
BillingCurrencyCustom
objectDescribes custom currency.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The type of the currency.
Allowed values:custom
The name of the currency. It should be a human-readable string that represents the name of the currency, such as “US Dollar” or “Euro”.
>= 1 characters<= 256 characters
Description of the currency.
>= 1 characters<= 256 characters
The symbol of the currency. It should be a string that represents the symbol of the currency, such as “$” for US Dollar or “€” for Euro.
>= 1 characters
Custom currency code.
It should be a unique code but not conflicting with any existing fiat currency codes.
>= 3 characters<= 24 characters
An ISO-8601 timestamp representation of the custom currency creation date.
Example:2023-01-01T01:01:01.001Z
BillingCurrencyFiat
objectCurrency describes a currency supported by the billing system.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The type of the currency.
Allowed values:fiat
The name of the currency. It should be a human-readable string that represents the name of the currency, such as “US Dollar” or “Euro”.
>= 1 characters<= 256 characters
Description of the currency.
>= 1 characters<= 256 characters
The symbol of the currency. It should be a string that represents the symbol of the currency, such as “$” for US Dollar or “€” for Euro.
>= 1 characters
Three-letter ISO4217 currency code.
Custom three-letter currency codes are also supported for convenience.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
BillingTaxCode
objectTax codes by provider.
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
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
Mapping of app types to tax codes.