Delete tax code

delete

Path Parameters

taxCodeIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Deleted response.

delete/openmeter/tax-codes/{taxCodeId}
 

OpenMeter Billing

Billing manages the billing profiles, currencies, cost bases, and invoices for customers.

List currencies

List currencies supported by the billing system.

get

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters
filterobject

Filter options for listing currencies.

Show Child Parameters

Response

application/json

Page paginated response.

CurrencyPagePaginatedResponse

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
get/openmeter/currencies
 
application/json

Create custom currency

Create a custom currency.
This operation allows defining your own custom currency for billing purposes.

post

Body

application/json

CreateCurrencyCustomRequest

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

Response

application/json

CurrencyCustom created response.

BillingCurrencyCustom

Describes custom currency.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

typestringrequiredread-only

The type of the currency.

Allowed values:custom

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of the custom currency creation date.

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

post/openmeter/currencies/custom

Body

{ "name": "name", "code": "code" }
 
application/json

List cost bases

List cost bases for a currency.
For custom currencies, there can be multiple cost bases with different effective_from dates.

get

Query Parameters

filterobject

Filter options for listing cost bases.

Show Child Parameters
pageobject

Determines which page of the collection to retrieve.

Show Child Parameters

Path Parameters

currencyIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

Page paginated response.

CostBasisPagePaginatedResponse

Page paginated response.

dataarray[object]required

Describes currency basis supported by billing system.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/openmeter/currencies/custom/{currencyId}/cost-bases
 
application/json