Saltar para a documentação
API

Ativar ou desativar o pagamento por utilização

O interruptor de Planos e faturação, e o cartão de que precisa da primeira vez.

PATCH/billing/pay-as-you-go

Executa qualquer uma das 2 chamadas no seu espaço de trabalho.

PATCH /billing/pay-as-you-go

O interruptor de Planos e faturação, e o cartão de que precisa da primeira vez.

Exemplo

Requer billing:write. Desativar tem efeito imediato, e a utilização para nas quotas. Ativar tem efeito imediato quando há um cartão guardado. Da primeira vez, checkoutUrl é uma ligação onde a pessoa adiciona um cartão, e o pagamento por utilização começa quando o tiver feito. theme e locale dão estilo à página que a ligação abre.

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
Resposta
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

Nada se paga através da API. A ligação abre a página do prestador de pagamentos, onde a pessoa paga, muda o cartão ou cancela, como faz a partir da app.

Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.

Depois do pagamento

Requer billing:write. Depois de a pessoa adicionar o cartão, POST /billing/pay-as-you-go/confirm verifica junto do prestador de pagamentos e regista-o, como a app faz quando ela volta. enabled diz se o pagamento por utilização está ativado agora, e voltar a chamá-lo é seguro.

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
Resposta
{ "object": "pay_as_you_go_confirmation", "enabled": true }

activating: true vindo do interruptor significa que um cartão acabou de ser guardado e que o pagamento por utilização está a ser ativado, por isso volte a lê-lo daqui a pouco.

Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.

Referência