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

BillingAppStripe

object

Stripe app.

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

BillingAppStripeCreateCheckoutSessionResult

object

Result of creating a Stripe Checkout Session.

Contains all the information needed to redirect customers to the checkout
or initialize an embedded checkout flow.

customer_idstringrequired

The customer ID in the billing system.

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

stripe_customer_idstringrequired

The Stripe customer ID.

session_idstringrequired

The Stripe checkout session ID.

setup_intent_idstringrequired

The setup intent ID created for collecting the payment method.

client_secretstring

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

client_reference_idstring

The client reference ID provided in the request.

Useful for reconciling the session with your internal systems.

customer_emailstring

Customer’s email address if provided to Stripe.

currencystring

Currency code for the checkout session.

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

>= 3 characters<= 3 characters

Example:USD

created_atstring(date-time)required

Timestamp when the checkout session was created.

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

expires_atstring(date-time)

Timestamp when the checkout session will expire.

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

metadataobject

Metadata attached to the checkout session.

urlstring

URL to redirect customers to the checkout page (for hosted mode).

modestringrequired

Mode of the checkout session.

Currently only “setup” mode is supported for collecting payment methods.

Allowed values:setup

cancel_urlstring

The cancel URL where customers are redirected if they cancel.

success_urlstring

The success URL where customers are redirected after completion.

return_urlstring

The return URL for embedded sessions after authentication.

Example

BillingAppStripeCreateCustomerPortalSessionResult

object

Result of creating a Stripe Customer Portal Session.

Contains all the information needed to redirect the customer to the Stripe Customer Portal.

idstringrequired
stripe_customer_idstringrequired

The ID of the stripe customer.

configuration_idstringrequired
created_atstring(date-time)required

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

localestringrequired

The IETF language tag of the locale customer portal is displayed in.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale

urlstringrequired

The URL to redirect the customer to after they have completed
their requested actions.

Example

BillingCustomer

object

Customers can be individuals or organizations that can subscribe to plans and have access to 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

keystringrequired

ExternalResourceKey is a unique string that is used to identify a resource in an external system.

>= 1 characters<= 256 characters

Example:019ae40f-4258-7f15-9491-842f42a7d6ac

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

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

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters
Example