Search documentation of stripe_elixir

# StripeElixir.Params.CouponUpdateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for coupon update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.CouponUpdateParams{
      currency_options: map() | nil,
      expand: [String.t()] | nil,
      metadata: map() | nil,
      name: String.t() | nil
    }

- `currency_options` - Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter ISO currency code and a supported currency.
- `expand` - Specifies which fields in the response should be expanded.
- `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` - Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. Max length: 40.