The Customer Session object 

Attributes

• client_secretstring

  The client secret of this Customer Session. Used on the client to set up secure access to the given customer.

  The client secret can be used to provide access to customer from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.

• componentsobject

  This hash defines which component is enabled and the features it supports.

  Hide child attributes

  • components.buy_buttonobject

    Configuration for buy button.

    Hide child attributes

    • components.buy_button.enabledboolean

      Whether the buy button is enabled.

  • components.customer_sheetobject

    Configuration for the customer sheet.

    Hide child attributes

    • components.customer_sheet.enabledboolean

      Whether the customer sheet is enabled.

    • components.customer_sheet.featuresnullable object

      This hash defines whether the customer sheet supports certain features.

      Hide child attributes

      • components.customer_sheet.features.payment_method_allow_redisplay_filtersnullable array of enums

        A list of allow_redisplay values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an allow_redisplay value that is present in this list.

        If not specified, defaults to [“always”]. In order to display all saved payment methods, specify [“always”, “limited”, “unspecified”].

        Possible enum values

        always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

        limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

        unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

      • components.customer_sheet.features.payment_method_removenullable enum

        Controls whether the customer sheet displays the option to remove a saved payment method."

        Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the customer object from that PaymentMethod.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

  • components.mobile_payment_elementobject

    Configuration for the mobile payment element.

    Hide child attributes

    • components.mobile_payment_element.enabledboolean

      Whether the mobile payment element is enabled.

    • components.mobile_payment_element.featuresnullable object

      This hash defines whether the mobile payment element supports certain features.

      Hide child attributes

      • components.mobile_payment_element.features.payment_method_allow_redisplay_filtersnullable array of enums

        A list of allow_redisplay values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an allow_redisplay value that is present in this list.

        If not specified, defaults to [“always”]. In order to display all saved payment methods, specify [“always”, “limited”, “unspecified”].

        Possible enum values

        always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

        limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

        unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

      • components.mobile_payment_element.features.payment_method_redisplaynullable enum

        Controls whether or not the mobile payment element shows saved payment methods.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.mobile_payment_element.features.payment_method_removenullable enum

        Controls whether the mobile payment element displays the option to remove a saved payment method."

        Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the customer object from that PaymentMethod.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.mobile_payment_element.features.payment_method_savenullable enum

        Controls whether the mobile payment element displays a checkbox offering to save a new payment method.

        If a customer checks the box, the allow_redisplay value on the PaymentMethod is set to 'always' at confirmation time. For PaymentIntents, the setup_future_usage value is also set to the value defined in payment_method_save_usage.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.mobile_payment_element.features.payment_method_save_allow_redisplay_overridenullable enum

        Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: “always”, “limited”, or “unspecified”.

        If not specified, defaults to nil (no override value).

        Possible enum values

        always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

        limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

        unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

  • components.payment_elementobject

    Configuration for the Payment Element.

    Hide child attributes

    • components.payment_element.enabledboolean

      Whether the Payment Element is enabled.

    • components.payment_element.featuresnullable object

      This hash defines whether the Payment Element supports certain features.

      Hide child attributes

      • components.payment_element.features.payment_method_allow_redisplay_filtersarray of enums

        A list of allow_redisplay values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an allow_redisplay value that is present in this list.

        If not specified, defaults to [“always”]. In order to display all saved payment methods, specify [“always”, “limited”, “unspecified”].

        Possible enum values

        always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

        limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

        unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

      • components.payment_element.features.payment_method_redisplayenum

        Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to disabled.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.payment_element.features.payment_method_redisplay_limitnullable integer

        Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to 3. The maximum redisplay limit is 10.

      • components.payment_element.features.payment_method_removeenum

        Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to disabled.

        Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the customer object from that PaymentMethod.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.payment_element.features.payment_method_saveenum

        Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to disabled.

        If a customer checks the box, the allow_redisplay value on the PaymentMethod is set to 'always' at confirmation time. For PaymentIntents, the setup_future_usage value is also set to the value defined in payment_method_save_usage.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.payment_element.features.payment_method_save_usagenullable enum

        When using PaymentIntents and the customer checks the save checkbox, this field determines the setup_future_usage value used to confirm the PaymentIntent.

        When using SetupIntents, directly configure the usage value on SetupIntent creation.

        Possible enum values

        off_session Use off_session if your customer may or may not be present in your checkout flow.

        on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • components.pricing_tableobject

    Configuration for the pricing table.

    Hide child attributes

    • components.pricing_table.enabledboolean

      Whether the pricing table is enabled.

  • components.tax_id_elementobjectPreview feature

    Configuration for the Tax ID Element.

    Hide child attributes

    • components.tax_id_element.enabledboolean

      Whether the Tax ID Element is enabled.

    • components.tax_id_element.featuresnullable object

      This hash defines whether the Tax ID Element supports certain features.

      Hide child attributes

      • components.tax_id_element.features.tax_id_redisplayenum

        Controls whether the Tax ID Element displays saved tax IDs for the customer. This parameter defaults to disabled.

        When enabled, the Tax ID Element will show existing tax IDs associated with the customer, allowing them to select from previously saved tax identification numbers.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

      • components.tax_id_element.features.tax_id_saveenum

        Controls whether the Tax ID Element allows merchants to save new tax IDs for their customer. This parameter defaults to disabled.

        When enabled, customers can enter and save new tax identification numbers during the payment flow, which will be stored securely and associated with their customer object for future use.

        Possible enum values

        disabled The feature is disabled.

        enabled The feature is enabled.

• customerstringExpandable

  The Customer the Customer Session was created for.

• expires_attimestamp

  The timestamp at which this Customer Session will expire.

More attributes

Collapse all

• objectstring

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

• createdtimestamp

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

• livemodeboolean

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