tiger_stripe

# File generated from our OpenAPI spec
defmodule Stripe.Params.CustomerUpdateParams do
  @moduledoc "Parameters for customer update."

  @typedoc """
  * `address` - The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).
  * `balance` - An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
  * `business_name` - The customer's business name. This may be up to *150 characters*.
  * `cash_balance` - Balance information and default balance settings for this customer.
  * `default_source` - If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.

  Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.

  If you want to add a new payment source and make it the default, see the [source](https://docs.stripe.com/api/customers/update#update_customer-source) property. Max length: 500.
  * `description` - An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. Max length: 5000.
  * `email` - Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. Max length: 512.
  * `expand` - Specifies which fields in the response should be expanded.
  * `individual_name` - The customer's full name. This may be up to *150 characters*.
  * `invoice_prefix` - The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. Max length: 5000.
  * `invoice_settings` - Default invoice settings for this customer.
  * `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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 customer's full name or business name. Max length: 256.
  * `next_invoice_sequence` - The sequence to be used on the customer's next invoice. Defaults to 1.
  * `phone` - The customer's phone number. Max length: 20.
  * `preferred_locales` - Customer's preferred languages, ordered by preference.
  * `shipping` - The customer's shipping information. Appears on invoices emailed to this customer.
  * `source` - Max length: 5000.
  * `tax` - Tax details about the customer.
  * `tax_exempt` - The customer's tax exemption. One of `none`, `exempt`, or `reverse`. Possible values: `exempt`, `none`, `reverse`.
  * `validate`
  """
  @type t :: %__MODULE__{
          address: map() | nil,
          balance: integer() | nil,
          business_name: map() | nil,
          cash_balance: cash_balance() | nil,
          default_source: String.t() | nil,
          description: String.t() | nil,
          email: String.t() | nil,
          expand: [String.t()] | nil,
          individual_name: map() | nil,
          invoice_prefix: String.t() | nil,
          invoice_settings: invoice_settings() | nil,
          metadata: map() | nil,
          name: String.t() | nil,
          next_invoice_sequence: integer() | nil,
          phone: String.t() | nil,
          preferred_locales: [String.t()] | nil,
          shipping: map() | nil,
          source: String.t() | nil,
          tax: tax() | nil,
          tax_exempt: String.t() | nil,
          validate: boolean() | nil
        }

  defstruct [
    :address,
    :balance,
    :business_name,
    :cash_balance,
    :default_source,
    :description,
    :email,
    :expand,
    :individual_name,
    :invoice_prefix,
    :invoice_settings,
    :metadata,
    :name,
    :next_invoice_sequence,
    :phone,
    :preferred_locales,
    :shipping,
    :source,
    :tax,
    :tax_exempt,
    :validate
  ]

  @typedoc """
  * `settings` - Settings controlling the behavior of the customer's cash balance,
  such as reconciliation of funds received.
  """
  @type cash_balance :: %{
          optional(:settings) => cash_balance_settings() | nil,
          optional(String.t()) => term()
        }

  @typedoc """
  * `reconciliation_mode` - Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://docs.stripe.com/payments/customer-balance/reconciliation). Possible values: `automatic`, `manual`, `merchant_default`.
  """
  @type cash_balance_settings :: %{
          optional(:reconciliation_mode) => String.t() | nil,
          optional(String.t()) => term()
        }

  @typedoc """
  * `custom_fields` - The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
  * `default_payment_method` - ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. Max length: 5000.
  * `footer` - Default footer to be displayed on invoices for this customer. Max length: 5000.
  * `rendering_options` - Default options for invoice PDF rendering for this customer.
  """
  @type invoice_settings :: %{
          optional(:custom_fields) => map() | nil,
          optional(:default_payment_method) => String.t() | nil,
          optional(:footer) => String.t() | nil,
          optional(:rendering_options) => map() | nil,
          optional(String.t()) => term()
        }

  @typedoc """
  * `ip_address` - A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
  * `validate_location` - A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`. Possible values: `auto`, `deferred`, `immediately`.
  """
  @type tax :: %{
          optional(:ip_address) => map() | nil,
          optional(:validate_location) => String.t() | nil,
          optional(String.t()) => term()
        }
end