moip_ex v0.3.0 MoipEx.Subscription

Representação de uma assinatura

Summary

Functions

  • :code - Identificador da assinatura na sua aplicação. Até 65 caracteres.
  • :amount - Valor da assinatura (sobrescreve o valor do plano contratado) atenção: o cliente deve estar ciente e de acordo em ser cobrado um valor diferente do plano escolhido
  • :plan - Dados do plano da assinatura
  • :customer - Dados do assinante
  • :payment_method - Método de pagamento. Pode ser CREDIT_CARD ou BOLETO
  • :creation_date - Data de criação da assinatura
  • :next_invoice_date - Data da proxima fatura
  • :status - Status da assinatura. Pode ser Active, suspended, expired,overdue, canceled ou trial
  • :trial - Dados do trial
  • :coupon - Dados do cupon utilizado na assinatura
  • :_links - Links relacionados. Ex: Link para boleto

Types

t()
t() :: %MoipEx.Subscription{_links: MoipEx.Links.t, amount: String.t, code: String.t, coupon: MoipEx.Coupon.t, creation_date: MoipEx.DateTime.t, customer: MoipEx.Customer.t, expiration_date: MoipEx.Date.t, next_invoice_date: MoipEx.Date.t, payment_method: String.t, plan: MoipEx.Plan.t, status: String.t, trial: MoipEx.Trial.t}

Functions

%MoipEx.Subscription{} (struct)
  • :code - Identificador da assinatura na sua aplicação. Até 65 caracteres.
  • :amount - Valor da assinatura (sobrescreve o valor do plano contratado) atenção: o cliente deve estar ciente e de acordo em ser cobrado um valor diferente do plano escolhido
  • :plan - Dados do plano da assinatura
  • :customer - Dados do assinante
  • :payment_method - Método de pagamento. Pode ser CREDIT_CARD ou BOLETO
  • :creation_date - Data de criação da assinatura
  • :next_invoice_date - Data da proxima fatura
  • :status - Status da assinatura. Pode ser Active, suspended, expired,overdue, canceled ou trial
  • :trial - Dados do trial
  • :coupon - Dados do cupon utilizado na assinatura
  • :_links - Links relacionados. Ex: Link para boleto
activate(subscription_code)
associate_coupon(subscription_code, coupon_code)
associate_coupon(subscription_code, coupon_code, plan_code)
cancel(subscription_code)
cancel_all_by_customer(customer_code)
change(subscription)
create(subscription, new_customer \\ false)
delete_coupon(subscription_code)
get(subscription_code)
list()
list_by_customer(customer_code)
suspend(subscription_code)