moip_ex v0.3.0 MoipEx.Plan

Representação de um plano

Summary

Functions

  • :code - Identificador do plano na sua aplicação. Até 65 caracteres
  • :name - Nome do plano na sua aplicação. Até 65 caracteres
  • :description - Descrição do plano na sua aplicação. Até 255 caracteres
  • :amount - Valor do plano a ser cobrado em centavos de Real. obrigatório
  • :setup_fee - Taxa de contratação a ser cobrada na assinatura em centavos de Real
  • :max_qty - Quantidade máxima de assinaturas do plano (não há limite se não informar)
  • :billing_cycles - Quantidade de ciclos (faturas) que a assinatura terá até expirar (se não informar, não haverá expiração)
  • :trial - Dados do trial
  • :status - Status do plano. Pode ser ACTIVE ou INACTIVE. O padrão é ACTIVE
  • :payment_method - Formas de pagamentos aceitas no plano. BOLETO, CREDIT_CARD ou ALL. Caso o atributo não seja informado, a forma de pagamento default é CREDIT_CARD.
  • :id - Identificador do plano moip

Types

t()
t() :: %MoipEx.Plan{amount: integer, billing_cycles: integer, code: String.t, description: String.t, id: String.t, interval: MoipEx.Interval.t, max_qty: integer, name: String.t, payment_method: String.t, setup_fee: integer, status: term, trial: MoipEx.Trial.t}

Functions

%MoipEx.Plan{} (struct)
  • :code - Identificador do plano na sua aplicação. Até 65 caracteres
  • :name - Nome do plano na sua aplicação. Até 65 caracteres
  • :description - Descrição do plano na sua aplicação. Até 255 caracteres
  • :amount - Valor do plano a ser cobrado em centavos de Real. obrigatório
  • :setup_fee - Taxa de contratação a ser cobrada na assinatura em centavos de Real
  • :max_qty - Quantidade máxima de assinaturas do plano (não há limite se não informar)
  • :billing_cycles - Quantidade de ciclos (faturas) que a assinatura terá até expirar (se não informar, não haverá expiração)
  • :trial - Dados do trial
  • :status - Status do plano. Pode ser ACTIVE ou INACTIVE. O padrão é ACTIVE
  • :payment_method - Formas de pagamentos aceitas no plano. BOLETO, CREDIT_CARD ou ALL. Caso o atributo não seja informado, a forma de pagamento default é CREDIT_CARD.
  • :id - Identificador do plano moip
activate(plan_code)
change(plan)
create(plan)
get(plan_code)
inactivate(plan_code)
list()