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

BillingCustomerData

object

Billing customer data.

billing_profileobject

The billing profile for the customer.

If not provided, the default billing profile will be used.

Show Child Parameters
app_dataobject

App customer data.

Show Child Parameters
Example

BillingCustomerStripeCreateCheckoutSessionRequest

object

Request to create a Stripe Checkout Session for the customer.

Checkout Sessions are used to collect payment method information from customers
in a secure, Stripe-hosted interface. This integration uses setup mode to collect
payment methods that can be charged later for subscription billing.

stripe_optionsobjectrequired

Options for configuring the Stripe Checkout Session.

These options are passed directly to Stripe’s checkout session creation API.

Show Child Parameters
Example

BillingCustomerStripeCreateCustomerPortalSessionRequest

object

Request to create a Stripe Customer Portal Session for the customer.

Useful to redirect the customer to the Stripe Customer Portal to manage their payment methods,
change their billing address and access their invoice history.
Only returns URL if the customer billing profile is linked to a stripe app and customer.

stripe_optionsobjectrequired

Options for configuring the Stripe Customer Portal Session.

Show Child Parameters
Example