Controlar a cobrança

PATCH /api/instance/billing/:instance Define o modo de cobrança de uma instância. Use para pular o teste e cobrar desde já. A troca é de mão única: uma vez em cobrança, a instância não volta para teste. Autentique com o TokenAccount da conta, o mesmo que você usa para criar e administrar instâncias.

Modos de cobrança

`billingMode`	O que faz
`trial`	Modo padrão de uma instância nova. A instância ganha os dias de teste do seu contrato a partir da primeira conexão.
`billable`	Cobra a instância desde já, sem dias grátis. Útil para um cliente que já testou antes e está voltando.

A mudança para billable é definitiva. Uma instância em cobrança não pode voltar para trial, a API responde 400.

Exemplo

curl -X PATCH "https://ryzeapi.cloud/api/instance/billing/minha-instancia" \
  -H "token: $Token_Account" \
  -H "Content-Type: application/json" \
  -d '{"billingMode": "billable"}'

await fetch("https://ryzeapi.cloud/api/instance/billing/minha-instancia", {
  method: "PATCH",
  headers: {
    "token": process.env.Token_Account,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ billingMode: "billable" })
});

import os, requests

requests.patch(
    "https://ryzeapi.cloud/api/instance/billing/minha-instancia",
    headers={
        "token": os.environ["Token_Account"],
        "Content-Type": "application/json"
    },
    json={"billingMode": "billable"}
)

Resposta de sucesso

200 OK

{
  "billingMode": "billable"
}

A resposta confirma o modo que ficou vigente na instância.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

O seu TokenAccount, o mesmo que você usa para criar e administrar instâncias.

Body

string

obrigatório

Um de trial ou billable. Uma vez billable, a instância não pode voltar para trial.

O que acontece em cada mudança

Para billable

A instância passa a ser cobrada a partir de agora. Se ela já estiver conectada, o valor comprometido do ciclo começa a contar neste momento e vai até a renovação, mesmo que você delete a instância antes.

Para trial

Só vale enquanto a instância ainda não entrou em cobrança. Uma instância que já é billable não volta para teste, a API responde 400. O teste segue as regras do seu contrato e o histórico do número.

Erros

HTTP	`error`	Quando
400	`billingMode obrigatorio`	O corpo não trouxe o campo `billingMode`.
400	`billingMode invalido (trial\|billable)`	Valor fora dos dois aceitos.
400	`instancia billable nao pode voltar para trial`	A instância já está em cobrança e não pode voltar para teste.
401	`Invalid token`	Token ausente ou inválido.
403	`Instance does not belong to your account`	A instância não é da sua conta.
404	`instance not found`	Nome não existe.

Como a cobrança funciona

Entenda o crédito, o teste e a medição por dia.

Webhooks Enterprise

Reaja a cada virada de estado por evento.

Primeiros passos

Cobrança

Auditoria

Referência

Controlar a cobrança

Modos de cobrança

Exemplo

Resposta de sucesso

Path parameters

Headers

Body

O que acontece em cada mudança

Erros

Próximo

Como a cobrança funciona

Webhooks Enterprise

​Modos de cobrança

​Exemplo

​Resposta de sucesso

​Path parameters

​Headers

​Body

​O que acontece em cada mudança

​Erros

​Próximo

Como a cobrança funciona

Webhooks Enterprise

Modos de cobrança

Exemplo

Resposta de sucesso

Path parameters

Headers

Body

O que acontece em cada mudança

Erros

Próximo