Docs
Guia do Usuário
  • Sumário de Implementação
  • API Explorer
    • API
    post https://billing.iugu.com/api/invoices/apply_discount

    Aplica um desconto na fatura que o cliente tem em aberto (mês corrente)

    Aplica um desconto na fatura que o cliente tem em aberto (mês corrente). O desconto é aplicado na fatura atual do app que está fazendo a chamada, no workspace informado.

    Permissão necessária: billing:invoices.apply_discount

    Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

    Schema Obrigatório

    Tipo de conteúdo: application/json
    customer_workspace_id

    Obrigatório

    String

    ID do workspace do cliente

    Ex: 4fHECmQtLdROI4fDLWMiLd
    amount

    Obrigatório

    Number

    Valor do desconto a ser aplicado

    Ex: 100.5
    Exemplo 
    1
2
3
4

    {
  "customer_workspace_id": "4fHECmQtLdROI4fDLWMiLd",
  "amount": 100.5
}

    Parâmetros no Cabeçalho

    • workspace_id

      Obrigatório

      String

      Identificador do workspace

      Ex: 4fHECmQtLdROI4fDLWMiLd

    Respostas
    200
    Desconto aplicado com sucesso
    success
    Boolean

    Ex: true
    applied_discount
    Number

    Valor do desconto aplicado

    Ex: 100.5
    404
    Assinatura não encontrada
    422
    Erro de validação. Possíveis motivos: - ID do workspace inválido ou não fornecido - Valor do desconto inválido (maior que o valor da fatura ou menor/igual a zero)

    Voltar

    Retorna o valor pendente da fatura que o cliente tem em aberto (mês corrente)