BillingAppCustomerData
objectApp customer data.
Used if the customer has a linked Stripe app.
Show Child Parameters
Used if the customer has a linked external invoicing app.
Show Child Parameters
BillingAppExternalInvoicing
objectExternal 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:
- The billing system creates invoices and transitions them through lifecycle states (draft → issuing → issued)
- The integration receives webhook notifications about invoice state changes
- The integration calls back to provide external system IDs and metadata
- 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.
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
The app type.
Allowed values:external_invoicing
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
Status of the app connection.
Allowed values:readyunauthorized
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 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.
BillingAppSandbox
objectSandbox app can be used for testing billing features.
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
The app type.
Allowed values:sandbox
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
Status of the app connection.
Allowed values:readyunauthorized
BillingAppStripe
objectStripe app.
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
The app type.
Allowed values:stripe
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
Status of the app connection.
Allowed values:readyunauthorized
The Stripe account ID associated with the connected Stripe account.
Indicates whether the app is connected to a live Stripe account.
The masked Stripe API key that only exposes the first and last few characters.
BillingAppStripeCreateCheckoutSessionResult
objectResult of creating a Stripe Checkout Session.
Contains all the information needed to redirect customers to the checkout
or initialize an embedded checkout flow.
The customer ID in the billing system.
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The Stripe customer ID.
The Stripe checkout session ID.
The setup intent ID created for collecting the payment method.
Client secret for initializing Stripe.js on the client side.
Required for embedded checkout sessions.
See: https://docs.stripe.com/payments/checkout/custom-success-page
The client reference ID provided in the request.
Useful for reconciling the session with your internal systems.
Customer’s email address if provided to Stripe.
Currency code for the checkout session.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
Timestamp when the checkout session was created.
Example:2023-01-01T01:01:01.001Z
Timestamp when the checkout session will expire.
Example:2023-01-01T01:01:01.001Z
Metadata attached to the checkout session.
The status of the checkout session.
See: https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-status
URL to redirect customers to the checkout page (for hosted mode).
Mode of the checkout session.
Currently only “setup” mode is supported for collecting payment methods.
Allowed values:setup
The cancel URL where customers are redirected if they cancel.
The success URL where customers are redirected after completion.
The return URL for embedded sessions after authentication.