Stripe.Params.PromotionCodeUpdateParams (tiger_stripe v0.3.0)

Parameters for promotion code update.

Summary

Types

t()

Types

restrictions()

@type restrictions() :: %{
  optional(:currency_options) =>
    %{required(String.t()) => restrictions_currency_options()} | nil,
  optional(String.t()) => term()
}

currency_options - Promotion codes defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

restrictions_currency_options()

@type restrictions_currency_options() :: %{
  optional(:minimum_amount) => integer() | nil,
  optional(String.t()) => term()
}

minimum_amount - Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

t()

@type t() :: %Stripe.Params.PromotionCodeUpdateParams{
  active: boolean() | nil,
  expand: [String.t()] | nil,
  metadata: map() | nil,
  restrictions: restrictions() | nil
}

active - Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
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.
restrictions - Settings that restrict the redemption of the promotion code.