Billing control

PATCH /api/instance/billing/:instance Sets the billing mode of an instance. Use it to skip the trial and bill right away. The switch is one-way: once billable, an instance does not go back to trial. Authenticate with your account TokenAccount, the same one you use to create and manage instances.

Billing modes

`billingMode`	What it does
`trial`	Default mode of a new instance. The instance gets your contract’s trial days starting from the first connection.
`billable`	Bills the instance right away, with no free days. Useful for a customer who already trialed before and is coming back.

Switching to billable is final. A billable instance cannot go back to trial, the API returns 400.

Example

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

await fetch("https://ryzeapi.cloud/api/instance/billing/my-instance", {
  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/my-instance",
    headers={
        "token": os.environ["Token_Account"],
        "Content-Type": "application/json"
    },
    json={"billingMode": "billable"}
)

Success response

200 OK

{
  "billingMode": "billable"
}

The response confirms the mode now in effect on the instance.

Path parameters

string

required

Instance name.

Headers

string

required

Your TokenAccount, the same one you use to create and manage instances.

Body

string

required

One of trial or billable. Once billable, the instance cannot go back to trial.

What happens on each change

To billable

The instance starts being billed from now on. If it is already connected, the committed amount for the cycle starts counting at this moment and runs until renewal, even if you delete the instance before that.

To trial

Only valid while the instance has not become billable yet. An instance that is already billable does not go back to trial, the API returns 400. The trial itself follows your contract rules and the number’s history.

Errors

HTTP	`error`	When
400	`billingMode obrigatorio`	The body did not include the `billingMode` field.
400	`billingMode invalido (trial\|billable)`	Value outside the two accepted ones.
400	`instancia billable nao pode voltar para trial`	The instance is already billable and cannot go back to trial.
401	`Invalid token`	Missing or invalid token.
403	`Instance does not belong to your account`	The instance is not yours.
404	`instance not found`	Name does not exist.

How billing works

Understand the credit, the trial and per-day metering.

Enterprise webhooks

React to each state change via events.

Getting started

Billing

Audit

Reference

Billing control

Billing modes

Example

Success response

Path parameters

Headers

Body

What happens on each change

Errors

Next

How billing works

Enterprise webhooks

​Billing modes

​Example

​Success response

​Path parameters

​Headers

​Body

​What happens on each change

​Errors

​Next

How billing works

Enterprise webhooks

Billing modes

Example

Success response

Path parameters

Headers

Body

What happens on each change

Errors

Next