Search documentation of tiger_stripe

# Stripe.Params.CustomerUpdateParams (tiger_stripe v0.1.1)

Copy Markdown View Source

Parameters for customer update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Stripe.Params.CustomerUpdateParams{
      address: map() | nil,
      balance: integer() | nil,
      business_name: map() | nil,
      cash_balance: map() | 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: map() | 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: map() | nil,
      tax_exempt: String.t() | nil,
      validate: boolean() | nil
    }

- `address` - The customer's address. Learn about country-specific requirements for calculating tax.
- `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 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 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 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`