Aplicar cupom

Como usar para indicação ou cortesia: crie uma vez um cupom do tipo EXTRA_PERIOD (em Cupons), por exemplo INDICACAO com 1 mês. Quando o cliente ganhar o benefício, aplique esse código na assinatura dele.

A partir de quando vale (applyTo):

• NEXT_CYCLE (padrão): a cobrança atual não muda; o cupom vale a partir da próxima. No período grátis, a próxima cobrança é adiada.
• CURRENT_CYCLE: vale já para a cobrança atual.
  • Se ela ainda não foi gerada, o cupom entra quando for gerada.
  • Se já foi gerada por Pix ou boleto e está em aberto, ela é reemitida. No desconto, com o valor novo; no período grátis, com o mesmo valor e o vencimento adiado pelo período.
  • Se ela está vencida: no desconto, envie um dueDate posterior a hoje, que vira o vencimento da nova cobrança. No período grátis, não envie dueDate: a nova cobrança vence hoje mais o período do cupom.

Regras:

• Uma assinatura tem um cupom por vez. Se já houver cupom em vigor, a resposta é COUPON_ALREADY_ACTIVE; aplique o próximo quando ele terminar.
• Cupom e desconto recorrente (Aplicar desconto em uma cobrança com cycles) não valem juntos. Com desconto recorrente em vigor, encerre-o antes de aplicar o cupom.
• Valem as mesmas regras do checkout: validade, limite de usos, produtos permitidos e primeiro uso.
• CURRENT_CYCLE só reemite cobrança de Pix ou boleto. Se a cobrança atual é de cartão e já foi gerada, ou se já foi paga, use NEXT_CYCLE.
• Um desconto manual já lançado na cobrança atual impede o cupom de desconto com CURRENT_CYCLE. Remova o desconto ou use NEXT_CYCLE.
• dueDate só vale quando a cobrança atual é reemitida com desconto. Com cupom de período grátis, ou com a cobrança atual ainda não emitida, a resposta é DUE_DATE_NOT_APPLICABLE.
• No boleto, o boleto antigo não é cancelado ao reemitir, a menos que você envie cancelOpenBoleto: true.
• No Pix Automático, o valor de um débito não muda depois que a instrução foi enviada ao banco do pagador. Se a instrução do ciclo onde o cupom começaria já foi enviada, a resposta é PIX_AUTOMATICO_INSTRUCTED. Isso vale também para NEXT_CYCLE, quando o débito da próxima cobrança já foi instruído.

Erros:

• COUPON_ALREADY_ACTIVE: já há um cupom em vigor na assinatura.
• COUPON_NOT_FOUND, COUPON_INACTIVE, COUPON_NOT_STARTED, COUPON_EXPIRED, COUPON_EXHAUSTED, PRODUCT_NOT_ELIGIBLE, COUPON_FIRST_TIME_ONLY: o cupom não vale para esta assinatura.
• COUPON_NOT_APPLICABLE: a assinatura é uma venda avulsa (ONE_TIME), ou o cupom é só para cobranças avulsas.
• SUBSCRIPTION_NOT_CHANGEABLE: a assinatura está encerrada.
• CYCLE_ALREADY_SETTLED: a cobrança onde o cupom começaria já foi paga.
• NO_OPEN_DOCUMENT: com CURRENT_CYCLE, a cobrança atual já foi gerada e não tem Pix ou boleto em aberto para reemitir.
• COUPON_CONFLICTS_WITH_DISCOUNT: com CURRENT_CYCLE, a cobrança atual já tem desconto manual.
• COUPON_CONFLICTS_WITH_DISCOUNT_SCHEDULE: a assinatura tem desconto recorrente em vigor.
• DUE_DATE_REQUIRED: cupom de desconto com CURRENT_CYCLE, a cobrança atual está vencida e o dueDate não foi enviado.
• DUE_DATE_NOT_APPLICABLE: dueDate enviado com cupom de período grátis, ou com a cobrança atual ainda não emitida.
• PIX_AUTOMATICO_INSTRUCTED: a instrução de débito do ciclo já foi enviada ao banco.
• CYCLE_BEING_PROCESSED: a cobrança está sendo processada agora; tente de novo em alguns minutos.

Para um abatimento pontual em uma cobrança, sem cupom, use Aplicar desconto em uma cobrança.

Envie dryRun: true para ver o efeito sem aplicar.