improved

04/12/24 — Splits no endpoint de Criar Assinatura

Agora é possível fazer Split por Assinaturas!

Anteriormente, a funcionalidade de Splits era limitada ao endpoint de criação de faturas (POST /v1/invoices), permitindo regras variáveis de Split apenas nesse contexto. Com a nova atualização, o Split por Assinaturas foi introduzido, ampliando as possibilidades para usuários que utilizam o endpoint de criação de assinaturas (POST /v1/subscriptions). Essa melhoria permite a configuração direta do objeto splits durante a criação de uma assinatura.

O que muda na prática?

Agora, ao criar uma assinatura, é possível definir regras personalizadas de divisão de valores (Split) diretamente no momento da requisição. Isso oferece maior flexibilidade e automação na gestão de receitas, especialmente para negócios que dependem de repasses para diferentes contas.

Assim, as mesmas possibilidades já existentes para faturas estão disponíveis para assinaturas, promovendo um alinhamento entre as duas funcionalidades.


Exemplo de Requisição

Veja abaixo um exemplo prático de como configurar um Split durante a criação de uma assinatura:

curl --request POST \
     --url 'https://api.iugu.com/v1/subscriptions?api_token=seu-api_token' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "plan_identifier": "basic_plan",
  "customer_id": "282BF13F9DBF4D3D8C5D344FEA370F78",
  "splits": [
    {
      "recipient_account_id": "ID da Conta",
      "cents": 45
    }
  ]
}
'

Detalhamento do Payload:

ParâmetroDescrição
plan_identifierIdentificador único do plano de assinatura
customer_idID do cliente ao qual a assinatura será vinculada
splitsObjeto que define as regras de divisão de receita
recipient_account_idID da conta que receberá a parte do valor
centsQuantidade em centavos que será direcionada para essa conta

Importante ⚠️

  • Ao incluir regras de Split diretamente no payload da requisição de criação de assinaturas, as regras globais de Split configuradas na conta serão ignoradas. Nesse caso, as regras definidas no objeto splits prevalecerão.

Certifique-se de revisar a lógica de divisão antes de implementar essa funcionalidade para garantir que ela atenda às suas necessidades específicas.

Essa novidade traz mais flexibilidade para adaptar os processos de divisão de receitas às exigências do seu modelo de negócio!