Mayson Monorepo Documentation
    Preparing search index...

    Interface SessionCreateParams

    interface SessionCreateParams {
        configuration?: string;
        customer?: string;
        customer_account?: string;
        expand?: string[];
        flow_data?: Stripe.BillingPortal.SessionCreateParams.FlowData;
        locale?: Stripe.BillingPortal.SessionCreateParams.Locale;
        on_behalf_of?: string;
        return_url?: string;
    }
    Index

    Properties

    configuration? customer? customer_account? expand? flow_data? locale? on_behalf_of? return_url?

    Properties

    configuration?: string

    The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.

    customer?: string

    The ID of an existing customer.

    customer_account?: string

    The ID of an existing account.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    flow_data?: Stripe.BillingPortal.SessionCreateParams.FlowData

    Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.

    locale?: Stripe.BillingPortal.SessionCreateParams.Locale

    The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's preferred_locales or browser's locale is used.

    on_behalf_of?: string

    The on_behalf_of account to use for this session. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.

    return_url?: string

    The default URL to redirect customers to when they click on the portal's link to return to your website.

    Settings

    Member Visibility

    On This Page

    Properties