Alterar as condições comerciais de um cliente
Muda preços, dia de vencimento ou canais receptivos, com motivo obrigatório. Todo preço enviado em terms passa a ser negociado com o cliente (mesmo igual ao padrão) e uma mudança dos padrões da plataforma não o alcança mais; os campos em revert voltam a seguir os padrões. Cada campo que mudou fica registrado com o motivo e quem mudou. Uma mudança de preço vale a partir da competência em effective_from (padrão: a em curso); uma competência futura fica agendada e passa a valer no primeiro dia dela; uma passada é recusada (422), porque um mês que já aconteceu se corrige com ajuste ou nota de crédito. Com vigência na competência em curso, a pré-fatura dela em revisão é recalculada e uma aprovada não muda (repricing). Os canais valem já. Os novos preços são validados como ficam, não como vieram.
Autorização
bearer billing:executeCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: billing:execute
Parâmetros de caminho
Id do cliente
int64Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
O corpo de PATCH /billing/profiles/{tenant_id}/terms: uma alteração
comercial, com motivo. O cadastro (CNPJ, e-mail, contatos) não entra aqui:
tem a rota dele.
Corpo da resposta
application/json
application/json
curl -X PATCH "https://example.com/billing/profiles/0/terms" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "asaas_customer_id": "string", "created_from_global_at": "2019-08-24T14:15:22Z", "dealer_id": 0, "dealer_name": "string", "exception_fields": [ "string" ], "receptive_channels_qty": 0, "receptive_channels_since": "2019-08-24", "registration": { "billing_email": "string", "cnpj": "string", "complete": true, "contacts": { "financial": { "email": "string", "name": "string", "telegram": "string", "whatsapp": "string" }, "technical": { "email": "string", "name": "string", "telegram": "string", "whatsapp": "string" } } }, "repricing": null, "tenant_id": 0, "tenant_name": "string", "terms": { "currency": "string", "due_day": 0, "platform_monthly_cents": 0, "receptive_channel_unit_cents": 0, "text_additional_cents": 0, "text_ia_allowance_cents": 0, "text_principal_cents": 0, "voice_additional_cents": 0, "voice_ia_allowance_cents": 0, "voice_principal_cents": 0 }, "updated_at": "2019-08-24T14:15:22Z"}