AppPagePaginatedResponse

object

Page paginated response.

dataOne Of
array[object]required

Installed application.

BillingAppStripeobject

Stripe app.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

BillingApp

object

Installed application.

One Of
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

typestringrequiredread-only

The app type.

Allowed values:stripe

definitionobjectrequiredread-only

The app catalog definition that this installed app is based on.

Example:{"type":"stripe","name":"Stripe","description":"Stripe integration allows you to collect payments with Stripe."}

Show Child Parameters
statusstringrequiredread-only

Status of the app connection.

Allowed values:readyunauthorized

account_idstringrequiredread-only

The Stripe account ID associated with the connected Stripe account.

livemodebooleanrequiredread-only

Indicates whether the app is connected to a live Stripe account.

masked_api_keystringrequiredread-only

The masked Stripe API key that only exposes the first and last few characters.

Example

BillingAppCustomerData

object

App customer data.

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

BillingAppExternalInvoicing

object

External Invoicing app enables integration with third-party invoicing or payment system.

The app supports a bi-directional synchronization pattern where OpenMeter Billing manages
the invoice lifecycle while the external system handles invoice presentation and payment collection.

Integration workflow:

  1. The billing system creates invoices and transitions them through lifecycle states (draft → issuing → issued)
  2. The integration receives webhook notifications about invoice state changes
  3. The integration calls back to provide external system IDs and metadata
  4. The integration reports payment events back via the payment status API

State synchronization is controlled by hooks that pause invoice progression until the
external system confirms synchronization via API callbacks.

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

typestringrequiredread-only

The app type.

Allowed values:external_invoicing

definitionobjectrequiredread-only

The app catalog definition that this installed app is based on.

Example:{"type":"stripe","name":"Stripe","description":"Stripe integration allows you to collect payments with Stripe."}

Show Child Parameters
statusstringrequiredread-only

Status of the app connection.

Allowed values:readyunauthorized

enable_draft_sync_hookbooleanrequired

Enable draft synchronization hook.

When enabled, invoices will pause at the draft state and wait for the integration
to call the draft synchronized endpoint before progressing to the issuing state.
This allows the external system to validate and prepare the invoice data.

When disabled, invoices automatically progress through the draft state based on
the configured workflow timing.

enable_issuing_sync_hookbooleanrequired

Enable issuing synchronization hook.

When enabled, invoices will pause at the issuing state and wait for the integration
to call the issuing synchronized endpoint before progressing to the issued state.
This ensures the external invoicing system has successfully created and finalized
the invoice before it is marked as issued.

When disabled, invoices automatically progress through the issuing state and are
immediately marked as issued.

Example

BillingAppSandbox

object

Sandbox app can be used for testing billing features.

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

typestringrequiredread-only

The app type.

Allowed values:sandbox

definitionobjectrequiredread-only

The app catalog definition that this installed app is based on.

Example:{"type":"stripe","name":"Stripe","description":"Stripe integration allows you to collect payments with Stripe."}

Show Child Parameters
statusstringrequiredread-only

Status of the app connection.

Allowed values:readyunauthorized

Example