moip_ex v0.3.0 MoipEx.Coupon

Representação de um cupom de desconto

Summary

Functions

  • :code - Código do identificador do coupon.
  • :name - Nome do cupom
  • :description - Descrição do cupom
  • :discount - Desconto dado ao cupom
  • :status - Status do cupom, ‘active’ ou ‘inactive’
  • :max_redemptions - Número máximo de submits do coupon até que ele seja inativado automaticamente
  • :expiration_date - Data de inativação do coupon, quando ele não poderá mais ser associado a novas assinaturas
  • :creation_date - Data e hora de criação do cupom
  • :in_use - Informa se o coupon está ou não aplicando suas regras em alguma assinatura

Types

t()
t() :: %MoipEx.Coupon{code: String.t, creation_date: MoipEx.DateTime.t, description: String.t, discount: MoipEx.Discount.t, duration: MoipEx.Duration.t, expiration_date: MoipEx.Date.t, in_use: nil, max_redemptions: integer, name: String.t, status: String.t}

Functions

%MoipEx.Coupon{} (struct)
  • :code - Código do identificador do coupon.
  • :name - Nome do cupom
  • :description - Descrição do cupom
  • :discount - Desconto dado ao cupom
  • :status - Status do cupom, ‘active’ ou ‘inactive’
  • :max_redemptions - Número máximo de submits do coupon até que ele seja inativado automaticamente
  • :expiration_date - Data de inativação do coupon, quando ele não poderá mais ser associado a novas assinaturas
  • :creation_date - Data e hora de criação do cupom
  • :in_use - Informa se o coupon está ou não aplicando suas regras em alguma assinatura.
activate(coupon_code)
create(coupon)
get(coupon_code)
get_by_subscription(subscription_code)
inactivate(coupon_code)
list()