CostBasisPagePaginatedResponse

object

Page paginated response.

dataarray[object]required

Describes currency basis supported by billing system.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

CreateCostBasisRequest

object

CostBasis create request.

fiat_codestringrequired

The fiat currency code for the cost basis.

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

>= 3 characters<= 3 characters

Example:USD

ratestringrequired

The cost rate for the currency.

Match pattern:^\-?[0-9]+(\.[0-9]+)?$

effective_fromstring(date-time)

An ISO-8601 timestamp representation of the date from which the cost basis is effective.
If not provided, it will be effective immediately and will set to now by the system.

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

Example

CreateCurrencyCustomRequest

object

CurrencyCustom create request.

namestringrequired

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

descriptionstring

Description of the currency.

>= 1 characters<= 256 characters

symbolstring

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

codestringrequired

Custom currency code.
It should be a unique code but not conflicting with any existing fiat currency codes.

>= 3 characters<= 24 characters

Example

CreateTaxCodeRequest

object

TaxCode 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

app_mappingsarray[object]required

Mapping of app types to tax codes.

Show Child Parameters
Example

CurrencyPagePaginatedResponse

object

Page paginated response.

dataOne Of
array[object]required

Fiat or custom currency.

BillingCurrencyFiatobject

Currency describes a currency supported by the billing system.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example