Skip to main content
Um fee_plan reúne as condições que sua plataforma cobra das organizações conectadas. Crie e edite os planos no painel; use a API para consultar as condições e atribuir um plano à organização. O catálogo comercial é compartilhado entre os modos teste e produção. livemode identifica o contexto da consulta ou do evento. Alterações feitas no painel valem para ambos os modos.

​
Atribuição e padrão

Na criação de uma organização, omitir fee_plan equivale a "default". Na atualização, omitir preserva a atribuição atual; enviar "default" restaura a herança. null é recusado. Enviar o ID do plano que hoje é padrão fixa esse plano, sem acompanhar futuras trocas do padrão. O ID do plano permanece igual quando suas taxas são editadas. As alterações valem para novas cobranças de todas as organizações atribuídas ao plano. Cobranças já criadas preservam as condições registradas.

​
Taxas e recebimento

rates contém 62 condições: 12 parcelas de crédito para cada uma das cinco curvas de bandeira, Pix e boleto. As taxas podem variar entre bandeiras. Em cartão, card_brand: null identifica as demais bandeiras aceitas; não substitui uma condição ausente de Visa, Mastercard, American Express ou Elo. fee_rate usa pontos-base: 399 significa 3,99%. fixed_fee_amount usa centavos: 99 significa R$ 0,99. fee_calculation_base indica se o percentual incide sobre a venda (chargeable) ou o total cobrado (total). prepaid e os settlement_days de cada condição são definidos pelo recebimento contratado e não podem ser editados no plano. No crédito, prepaid: false mantém o recebimento no fluxo das parcelas; true indica recebimento antecipado. Consulte ambos os campos: o prazo sozinho não define o fluxo de recebimento.

​
Eventos

fee.plan.created e fee.plan.updated são entregues aos endpoints de plataforma. Em uma troca de padrão, os planos anterior e atual recebem fee.plan.updated pela mudança de is_default. Organizações que seguem "default" continuam com a mesma atribuição e não recebem um organization.updated apenas por essa troca. A atribuição explícita de outro plano a uma organização gera organization.updated, com previous_attributes.fee_plan.

​
Data Object