Stripe.Params.CustomerSessionCreateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for customer session create.

Summary

Types

components()

@type components() :: %{
  optional(:buy_button) => components_buy_button() | nil,
  optional(:customer_sheet) => components_customer_sheet() | nil,
  optional(:mobile_payment_element) =>
    components_mobile_payment_element() | nil,
  optional(:payment_element) => components_payment_element() | nil,
  optional(:pricing_table) => components_pricing_table() | nil,
  optional(String.t()) => term()
}
  • buy_button - Configuration for buy button.
  • customer_sheet - Configuration for the customer sheet.
  • mobile_payment_element - Configuration for the mobile payment element.
  • payment_element - Configuration for the Payment Element.
  • pricing_table - Configuration for the pricing table.

components_buy_button()

@type components_buy_button() :: %{
  optional(:enabled) => boolean() | nil,
  optional(String.t()) => term()
}
  • enabled - Whether the buy button is enabled.

components_customer_sheet()

@type components_customer_sheet() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_customer_sheet_features() | nil,
  optional(String.t()) => term()
}
  • enabled - Whether the customer sheet is enabled.
  • features - This hash defines whether the customer sheet supports certain features.

components_customer_sheet_features()

@type components_customer_sheet_features() :: %{
  optional(:payment_method_allow_redisplay_filters) => [String.t()] | nil,
  optional(:payment_method_remove) => String.t() | nil,
  optional(String.t()) => term()
}
  • payment_method_allow_redisplay_filters - 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"].

  • payment_method_remove - 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 values: disabled, enabled.

components_mobile_payment_element()

@type components_mobile_payment_element() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_mobile_payment_element_features() | nil,
  optional(String.t()) => term()
}
  • enabled - Whether the mobile payment element is enabled.
  • features - This hash defines whether the mobile payment element supports certain features.

components_mobile_payment_element_features()

@type components_mobile_payment_element_features() :: %{
  optional(:payment_method_allow_redisplay_filters) => [String.t()] | nil,
  optional(:payment_method_redisplay) => String.t() | nil,
  optional(:payment_method_remove) => String.t() | nil,
  optional(:payment_method_save) => String.t() | nil,
  optional(:payment_method_save_allow_redisplay_override) => String.t() | nil,
  optional(String.t()) => term()
}
  • payment_method_allow_redisplay_filters - 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"].

  • payment_method_redisplay - Controls whether or not the mobile payment element shows saved payment methods. Possible values: disabled, enabled.
  • payment_method_remove - 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 values: disabled, enabled.

  • payment_method_save - 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 values: disabled, enabled.

  • payment_method_save_allow_redisplay_override - 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 values: always, limited, unspecified.

components_payment_element()

@type components_payment_element() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_payment_element_features() | nil,
  optional(String.t()) => term()
}
  • enabled - Whether the Payment Element is enabled.
  • features - This hash defines whether the Payment Element supports certain features.

components_payment_element_features()

@type components_payment_element_features() :: %{
  optional(:payment_method_allow_redisplay_filters) => [String.t()] | nil,
  optional(:payment_method_redisplay) => String.t() | nil,
  optional(:payment_method_redisplay_limit) => integer() | nil,
  optional(:payment_method_remove) => String.t() | nil,
  optional(:payment_method_save) => String.t() | nil,
  optional(:payment_method_save_usage) => String.t() | nil,
  optional(String.t()) => term()
}
  • payment_method_allow_redisplay_filters - 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"].

  • payment_method_redisplay - Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to disabled. Possible values: disabled, enabled.
  • payment_method_redisplay_limit - 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.
  • payment_method_remove - 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 values: disabled, enabled.

  • payment_method_save - 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 values: disabled, enabled.

  • payment_method_save_usage - 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 values: off_session, on_session.

components_pricing_table()

@type components_pricing_table() :: %{
  optional(:enabled) => boolean() | nil,
  optional(String.t()) => term()
}
  • enabled - Whether the pricing table is enabled.

t()

@type t() :: %Stripe.Params.CustomerSessionCreateParams{
  components: components(),
  customer: String.t() | nil,
  customer_account: String.t() | nil,
  expand: [String.t()] | nil
}
  • components - Configuration for each component. At least 1 component must be enabled.
  • customer - The ID of an existing customer for which to create the Customer Session. Max length: 5000.
  • customer_account - The ID of an existing Account for which to create the Customer Session. Max length: 5000.
  • expand - Specifies which fields in the response should be expanded.