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.
BillingAppStripeCreateCustomerPortalSessionResult
objectResult of creating a Stripe Customer Portal Session.
Contains all the information needed to redirect the customer to the Stripe Customer Portal.
The ID of the customer portal session.
See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
The ID of the stripe customer.
Configuration used to customize the customer portal.
See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
Example:2023-01-01T01:01:01.001Z
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
The URL to redirect the customer to after they have completed
their requested actions.
BillingCustomer
objectCustomers can be individuals or organizations that can subscribe to plans and have access to 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
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
Mapping to attribute metered usage to the customer by the event subject.
Show Child Parameters
The primary email address of the customer.
Currency of the customer.
Used for billing, tax and invoicing.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
The billing address of the customer.
Used for tax and invoicing.
Show Child Parameters
BillingCustomerData
objectBilling customer data.
The billing profile for the customer.
If not provided, the default billing profile will be used.
Show Child Parameters
App customer data.
Show Child Parameters
BillingCustomerStripeCreateCheckoutSessionRequest
objectRequest 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.
Options for configuring the Stripe Checkout Session.
These options are passed directly to Stripe’s checkout session creation API.