Create a new billing profile

Create a new billing profile.

Billing profiles contain the settings for billing and controls invoice generation.
An organization can have multiple billing profiles defined.
A billing profile is linked to a specific app. This association is established during the billing profile’s creation and remains immutable.

post

Body

application/json

CreateBillingProfileRequest

BillingProfile 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"}

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
appsobjectrequired

The applications used by this billing profile.

Show Child Parameters
defaultbooleanrequired

Whether this is the default profile.

Response

application/json

BillingProfile created response.

BillingProfile

Billing profiles contain the settings for billing and controls invoice generation.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

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

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

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

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
appsobjectrequired

The applications used by this billing profile.

Show Child Parameters
defaultbooleanrequired

Whether this is the default profile.

post/openmeter/profiles

Body

{ "name": "name", "supplier": {}, "workflow": {}, "apps": { "tax": { "id": "01G65Z755AFWAKHE12NY0CQ9FH" }, "invoicing": { "id": "01G65Z755AFWAKHE12NY0CQ9FH" }, "payment": { "id": "01G65Z755AFWAKHE12NY0CQ9FH" } }, "default": false }
 
application/json

Get a billing profile

Get a billing profile.

get

Path Parameters

idstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

BillingProfile response.

BillingProfile

Billing profiles contain the settings for billing and controls invoice generation.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

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

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

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

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
appsobjectrequired

The applications used by this billing profile.

Show Child Parameters
defaultbooleanrequired

Whether this is the default profile.

get/openmeter/profiles/{id}
 
application/json

Update a billing profile

Update a billing profile.

put

Path Parameters

idstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Body

application/json

UpsertBillingProfileRequest

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.

Response

application/json

BillingProfile updated response.

BillingProfile

Billing profiles contain the settings for billing and controls invoice generation.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

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

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

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

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
appsobjectrequired

The applications used by this billing profile.

Show Child Parameters
defaultbooleanrequired

Whether this is the default profile.

put/openmeter/profiles/{id}

Body

{ "name": "name", "supplier": {}, "workflow": {}, "default": false }
 
application/json

Delete a billing profile

Delete a billing profile.

Only such billing profiles can be deleted that are:

  • not the default profile
  • not pinned to any customer using customer overrides
  • only have finalized invoices
delete

Path Parameters

idstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Deleted response.

delete/openmeter/profiles/{id}
 

OpenMeter Apps

Apps enable you to extend and customize billing and usage workflows by integrating with external systems and services. Apps can automate and enhance your billing ecosystem by supporting capabilities such as synchronizing usage data with third-party platforms, calculating taxes, generating and delivering invoices, handling payment collection, and other billing-related tasks.