Mayson Monorepo Documentation
    Preparing search index...

    A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: Configure the customer portal.

    interface Configuration {
        id: string;
        object: "billing_portal.configuration";
        active: boolean;
        application: string | Application | DeletedApplication;
        business_profile: Stripe.BillingPortal.Configuration.BusinessProfile;
        created: number;
        default_return_url: string;
        features: Stripe.BillingPortal.Configuration.Features;
        is_default: boolean;
        livemode: boolean;
        login_page: Stripe.BillingPortal.Configuration.LoginPage;
        metadata: Metadata;
        name: string;
        updated: number;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "billing_portal.configuration"

    String representing the object's type. Objects of the same type share the same value.

    active: boolean

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

    application: string | Application | DeletedApplication

    ID of the Connect Application that created the configuration.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    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.

    is_default: boolean

    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

    name: string

    The name of the configuration.

    updated: number

    Time at which the object was last updated. Measured in seconds since the Unix epoch.