Alterar modo de faturamento

POST/recurrence/subscriptions/{id_subscriber}/invoices/{id_invoice}/change-mode

Atualizado em 21 de março de 2025 · 2 min de leitura

Altera o modo de faturamento de uma fatura entre automático e manual.

Altera o modo de faturamento de uma fatura específica de uma assinatura. Quando o modo é manual ou cancel, a fatura não será cobrada automaticamente pelo sistema — ficando a cargo do lojista realizar o faturamento manualmente.

POSThttps://{apiUrl}/recurrence/subscriptions/{id_subscriber}/invoices/{id_invoice}/change-mode

URL base da API

Token de autenticação

Path Params

id_subscriberstringrequired

UUID da assinatura

id_invoicestringrequired

UUID da fatura

Body Params

modestringrequired

Modo de faturamento: automatic, manual, cancel

curl --request POST \
  --url "https://{apiUrl}/recurrence/subscriptions/{id_subscriber}/invoices/{id_invoice}/change-mode" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Parâmetros

Path

Parâmetro	Tipo	Obrigatório	Descrição
`id_subscriber`	string	Sim	UUID da assinatura
`id_invoice`	string	Sim	UUID da fatura

Headers

Parâmetro	Tipo	Obrigatório	Descrição
`Authorization`	string	Sim	Chave privada no formato `Bearer {token}`

Body

Parâmetro	Tipo	Obrigatório	Descrição
`mode`	string	Sim	Modo de faturamento: `automatic`, `manual`, `cancel`

Exemplo de requisição

bash

curl --request POST \
  --url https://{apiUrl}/recurrence/subscriptions/{id_subscriber}/invoices/{id_invoice}/change-mode \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "mode": "manual"
  }'

Responses

Esta página foi útil?