Assinaturas e cobrança
Venda, altere e encerre os planos dos seus clientes e acompanhe as cobranças no seu cartão.
Cada espaço de trabalho de cliente pode ter uma assinatura de um nível que você vende. O cartão do seu revendedor paga as faturas de todos os espaços de trabalho. A assinatura atual de um espaço de trabalho fica no campo subscription de workspaces.list, junto com has_payment_issue.
Atribua um plano
Assine um plano para um espaço de trabalho que ainda não tem um. billing_period é monthly_period (o padrão) ou annual_period.
Envie uma idempotency_key gerada por você em cada atribuição ou alteração. Se uma solicitação expirar, repeti-la com a mesma chave impede que o espaço de trabalho seja assinado ou cobrado duas vezes.
A atribuição ou alteração de um plano é recusada enquanto has_payment_issue for true. Mostre a fatura não paga ao seu cliente ou pague-a pelo pay_url antes de tentar novamente.
Altere um plano
subscriptions.change recebe o mesmo corpo de assign.
- Um upgrade é aplicado imediatamente.
- Um downgrade ou uma mudança para um nível equivalente entra em vigor no fim do período de cobrança. Até lá, a assinatura mostra o novo nível em
pending_downgrade_tiere a data empending_downgrade_at_unix.
Para manter o espaço de trabalho no nível atual, cancele o downgrade agendado com subscriptions.cancel_pending_downgrade.
Quando um downgrade entra em vigor, as recepcionistas e os números de telefone que excedem os limites do novo plano são desativados, e os membros da equipe que excedem o tamanho permitido são suspensos.
Encerre um plano
subscriptions.unassign encerra a assinatura no fim do período de cobrança atual. Até lá, cancel_at_unix mostra quando ela termina, e subscriptions.restore desfaz o cancelamento para que o plano seja renovado normalmente.
Faturas
Cada cobrança no seu cartão paga a fatura de um espaço de trabalho. billing.list_invoices as retorna da mais recente à mais antiga, uma página por vez. O status de uma fatura é um destes:
billing.get_invoice adiciona as lines da fatura. Uma linha com amount_cents negativo é um crédito proporcional, e as linhas sempre somam o valor da cobrança.
Próximos pagamentos
billing.list_upcoming_payments estima a próxima renovação de cada espaço de trabalho, da mais próxima à mais distante. plan_usd é o plano cobrado antecipadamente na renovação, que corresponde ao preço do nível com downgrade quando há um downgrade agendado. overage_so_far_usd é o uso deste período que excede os minutos incluídos até agora. Ele é cobrado na renovação e continua aumentando até lá.