Mayson Monorepo Documentation
    Preparing search index...

    Interface ConfigurationUpdateParams

    interface ConfigurationUpdateParams {
        active?: boolean;
        business_profile?: Stripe.BillingPortal.ConfigurationUpdateParams.BusinessProfile;
        default_return_url?: string;
        expand?: string[];
        features?: Stripe.BillingPortal.ConfigurationUpdateParams.Features;
        login_page?: Stripe.BillingPortal.ConfigurationUpdateParams.LoginPage;
        metadata?: Emptyable<MetadataParam>;
        name?: string;
    }
    Index

    Properties

    active? business_profile? default_return_url? expand? features? login_page? metadata? name?

    Properties

    active?: boolean

    Whether the configuration is active and can be used to create portal sessions.

    business_profile?: Stripe.BillingPortal.ConfigurationUpdateParams.BusinessProfile

    The business information shown to customers in the portal.

    default_return_url?: string

    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    features?: Stripe.BillingPortal.ConfigurationUpdateParams.Features

    Information about the features available in the portal.

    Optionallogin_page

    login_page?: Stripe.BillingPortal.ConfigurationUpdateParams.LoginPage

    The hosted login page for this configuration. Learn more about the portal login page in our integration docs.

    metadata?: Emptyable<MetadataParam>

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    name?: string

    The name of the configuration.

    Settings

    Member Visibility

    On This Page

    Properties