tiger_stripe

# File generated from our OpenAPI spec
defmodule Stripe.Resources.PromotionCode do
  @moduledoc """
  PromotionCode

  A Promotion Code represents a customer-redeemable code for an underlying promotion.
  You can create multiple codes for a single promotion.

  If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
  Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
  """

  @typedoc """
  * `active` - Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
  * `code` - The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). Max length: 5000.
  * `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  * `customer` - The customer who can use this promotion code. Nullable. Expandable.
  * `customer_account` - The account representing the customer who can use this promotion code. Max length: 5000. Nullable.
  * `expires_at` - Date at which the promotion code can no longer be redeemed. Format: Unix timestamp. Nullable.
  * `id` - Unique identifier for the object. Max length: 5000.
  * `livemode` - If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
  * `max_redemptions` - Maximum number of times this promotion code can be redeemed. Nullable.
  * `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. Nullable.
  * `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `promotion_code`.
  * `promotion` - Expandable.
  * `restrictions` - Expandable.
  * `times_redeemed` - Number of times this promotion code has been used.
  """
  @type t :: %__MODULE__{}

  defstruct [
    :active,
    :code,
    :created,
    :customer,
    :customer_account,
    :expires_at,
    :id,
    :livemode,
    :max_redemptions,
    :metadata,
    :object,
    :promotion,
    :restrictions,
    :times_redeemed
  ]

  @object_name "promotion_code"
  def object_name, do: @object_name

  def expandable_fields, do: ["customer", "promotion", "restrictions"]

  def __nested_fields__ do
    %{
      "promotion" => %{
        fields: %{
          "coupon" => {:resource, Stripe.Resources.Coupon},
          "type" => :scalar
        }
      },
      "restrictions" => %{
        fields: %{
          "currency_options" =>
            {:map,
             %{
               fields: %{
                 "minimum_amount" => :scalar
               }
             }},
          "first_time_transaction" => :scalar,
          "minimum_amount" => :scalar,
          "minimum_amount_currency" => :scalar
        }
      }
    }
  end
end