Cria uma fatura recorrente

post

https://apisandbox.bempaggo.io/api/v2/sellers/{sellerId}/recurring-invoices

Cria uma nova fatura recorrente para um cliente específico

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sellerId

integer

required

ID do Seller.

Body Params

fine

object

Configuração de multa

interest

object

Configuração de juros

customerId

int32

required

ID do cliente que está sendo faturado

billingCycleStartDate

int64

required

Timestamp que indica o início do ciclo de cobrança

isBillingCycleStartDateOverridden

boolean

nextCycleDueDate

int64

Timestamp que indica a data de pagamento a partir da segunda cobrança

daysUntilDue

int32

required

≥ 0

Número de dias até a fatura vencer

billingFrequency

string

enum

required

Frequência de cobrança para o produto (ex: MONTHLY)

Allowed:

recurringItems

array of objects

required

length ≥ 1

Lista de itens recorrentes incluídos na fatura

recurringItems*

Item recorrente da fatura

productId

int32

required

ID do produto

quantity

int32

required

Quantidade do produto

unitPriceInCents

int64

required

Preço unitário do produto em centavos

maxBillingCycles

int32

required

1 to 9999

Número de ciclos de cobrança deve estar entre 1 e 9999. Não pode ser nulo.

extraItems

array of objects

Lista de itens não recorrentes incluídos na fatura

extraItems

acceptedPaymentMethods

array of objects

required

length ≥ 1

Métodos de pagamento aceitos para a fatura

acceptedPaymentMethods*

method

string

enum

required

Método de pagamento

amountOff

int64

required

Valor de desconto em centavos, exemplo: 105 = R$ 1,05

cardSettings

object

Configurações do cartão

pixSettings

object

Configurações do pix

boletoSettings

object

Configurações do boleto

notificationUrl

object

URL para notificações relacionadas à fatura

orderReference

string

length between 4 and 32

Número de referência externo, possibilitando a realização de pesquisa. Único.

collectionMethod

object

enum

required

Método de cobrança da fatura

splits

array of objects

splits

Responses

401

Não autorizado.

500

Erro interno do servidor

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

201A fatura foi criada com sucesso.

400Request mal formatado.

422O recurso não pode ser processado.