Search documentation of stripe_elixir

# StripeElixir.Params.BillingPortal.ConfigurationUpdateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for configuration update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.BillingPortal.ConfigurationUpdateParams{
      active: boolean() | nil,
      business_profile: map() | nil,
      default_return_url: map() | nil,
      expand: [String.t()] | nil,
      features: map() | nil,
      login_page: map() | nil,
      metadata: map() | nil,
      name: map() | nil
    }

- `active` - Whether the configuration is active and can be used to create portal sessions.
- `business_profile` - The business information shown to customers in the portal.
- `default_return_url` - 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` - Specifies which fields in the response should be expanded.
- `features` - Information about the features available in the portal.
- `login_page` - The hosted login page for this configuration. Learn more about the portal login page in our integration docs.
- `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. 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` - The name of the configuration.