📘 Fatura recorrente

Criando uma fatura recorrente com split

POST /api/v2/sellers/{sellerId}/recurring-invoices

{
   "customerId":1,
   "billingCycleStartDate":1736944528450,
   "daysUntilDue":7,
   "billingFrequency":"MONTHLY",
   "collectionMethod":"AUTOMATIC_CHARGE",
   "recurringItems":[
      {
         "quantity":1,
         "productId":1,
         "maxBillingCycles":10,
         "unitPriceInCents":1027
      }
   ],
   "acceptedPaymentMethods":[
      {
         "method":"CREDIT_CARD",
         "cardSettings":{
            "maxInstallments":10,
            "feePassThrough":true
         }
      },
      {
         "method":"PIX",
         "amountOff":1500
      },
      {
         "method":"BANK_SLIP",
         "amountOff":1000
      }
   ],
   "extraItems":[
      {
         "quantity":1,
         "productId":2,
         "unitPriceInCents":1027
      }
   ],
   "splits":[
      {
         "sellerId":2,
         "percentage":5.50,
         "cyclesToParticipate":1,
         "absorbBalance":false
      },
      {
         "sellerId":1,
         "percentage":94.50,
         "cyclesToParticipate":10,
         "absorbBalance":true
      }
   ]
}

Campos do JSON

Campos Principais

Campo	Tipo	Descrição
`customerId`	Integer	Identificador único do cliente para o qual a fatura recorrente está sendo criada.
`billingCycleStartDate`	Long (timestamp)	Data de início do ciclo de cobrança, em milissegundos desde o epoch.
`daysUntilDue`	Integer	Número de dias até a fatura vencer.
`billingFrequency`	String	Frequência de cobrança recorrente. Valores possíveis: `DAILY`, `WEEKLY`, `MONTHLY`, `YEARLY`.
`collectionMethod`	String	Método utilizado para coletar o pagamento. Valores possíveis: `AUTOMATIC_CHARGE`, `MANUAL_INVOICE`.

Objeto `recurringItems`

Array de objetos que define os itens recorrentes da cobrança.

Campo	Tipo	Descrição
`quantity`	Integer	Quantidade do produto ou serviço sendo cobrado.
`productId`	Integer	Identificador único do produto sendo cobrado.
`maxBillingCycles`	Integer	Número máximo de ciclos de cobrança para este item.
`unitPriceInCents`	Integer	Preço unitário do item em centavos.

Objeto `acceptedPaymentMethods`

Array de objetos que lista os métodos de pagamento aceitos.

Campo	Tipo	Descrição
`method`	String	Método de pagamento. Valores possíveis: `CREDIT_CARD`, `PIX`, `BANK_SLIP`.
`cardSettings`	Objeto (opcional)	Configurações específicas para cartões de crédito.
`amountOff`	Integer (opcional)	Valor do desconto em centavos para o método de pagamento selecionado.

Objeto `cardSettings`

Campo	Tipo	Descrição
`maxInstallments`	Integer	Número máximo de parcelas permitidas.
`feePassThrough`	Boolean	Indica se a taxa de pagamento será repassada para o cliente.

Objeto `extraItems`

Array de objetos que define os itens adicionais incluídos na fatura.

Campo	Tipo	Descrição
`quantity`	Integer	Quantidade do produto ou serviço sendo cobrado.
`productId`	Integer	Identificador único do produto sendo cobrado.
`unitPriceInCents`	Integer	Preço unitário do item em centavos.

Objeto `splits`

Array de objetos que define como o valor do pagamento será dividido entre os vendedores.

Campo	Tipo	Descrição
`sellerId`	Integer	Identificador único do vendedor que receberá parte do pagamento.
`percentage`	Float	Percentual do pagamento destinado ao vendedor.
`cyclesToParticipate`	Integer	Número de ciclos de cobrança nos quais o vendedor participará.
`absorbBalance`	Boolean	Indica se o vendedor absorverá o saldo restante quando outros participantes pararem de receber pagamentos.