Get customer billing data
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
application/json
Response
CustomerBillingData response.
BillingCustomerData
Billing 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
Authentication
Path Parameters
Update customer billing data
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
UpsertCustomerBillingDataRequest
CustomerBillingData upsert request.
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
Response
application/json
Response
CustomerBillingData upsert response.
BillingCustomerData
Billing 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
Authentication
Path Parameters
Body
Update customer billing app data
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
UpsertAppCustomerDataRequest
AppCustomerData upsert request.
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
Response
application/json
Response
AppCustomerData upsert response.
BillingAppCustomerData
App 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
Authentication
Path Parameters
Body
Create Stripe Checkout Session
Create a Stripe Checkout Session for the customer.
Creates a Checkout Session for collecting payment method information from customers.
The session operates in “setup” mode, which collects payment details without charging
the customer immediately. The collected payment method can be used for future
subscription billing.
For hosted checkout sessions, redirect customers to the returned URL. For embedded
sessions, use the client_secret to initialize Stripe.js in your application.
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
BillingCustomerStripeCreateCheckoutSessionRequest
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.
Options for configuring the Stripe Checkout Session.
These options are passed directly to Stripe’s checkout session creation API.
Show Child Parameters
Response
application/json
Response
CreateStripeCheckoutSessionResult created response.
BillingAppStripeCreateCheckoutSessionResult
Result 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.
Authentication
Path Parameters
Body
Create Stripe customer portal session
Create Stripe Customer Portal Session.
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.
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
BillingCustomerStripeCreateCustomerPortalSessionRequest
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.
Options for configuring the Stripe Customer Portal Session.
Show Child Parameters
Response
application/json
Response
CreateStripeCustomerPortalSessionResult created response.
BillingAppStripeCreateCustomerPortalSessionResult
Result 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.