Facturas e saldo

Consultar e pagar facturas com saldo, ver encomendas e cotações, mudar o ciclo de renovação e pedir um cancelamento pela API.

Ver as operaçõesPlayground
Nesta página
  1. Documentação
    2.  » 
  2. Facturas e saldo
Actualizado em 8 min de leitura
Ver em Markdown

A API lê as facturas, o saldo, as encomendas e as cotações, paga facturas com o saldo da conta, muda o ciclo da próxima renovação e regista pedidos de cancelamento. Só cobra do saldo: para pagar de outra forma, use o My MozOut ou o endereço url de cada factura.

O que precisa

ParaPermissão
Ler facturas, encomendas e cotações, ver ciclos e obter a ligação de upgradebilling:read
Mudar o ciclo da próxima renovaçãobilling:write
Pagar com saldobilling:pay, permissão perigosa
Pedir o cancelamento de um serviçoservices:cancel, permissão perigosa

Com uma chave sandbox_, ou enquanto a API está em preparação, as alterações são simuladas e nada é cobrado. Veja Sandbox e Produção. Os serviços estão em Hospedagem.

A lista de facturas

GET /v1/invoices devolve as facturas da conta, primeiro as mais recentes. Pode filtrar com status, por exemplo ?status=unpaid. A lista vem em páginas.

curl

curl "https://api.mozout.com/v1/invoices" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/invoices", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Os valores de uma factura

CampoO que é
totalO total da factura, incluindo o que foi pago com saldo.
credit_appliedO que foi pago com saldo.
balance_dueO que ainda falta pagar.

GET /v1/invoices/{id} devolve também as linhas da factura.

Descarregar o PDF

GET /v1/invoices/{id}/pdf devolve o PDF em content, em base64. Às vezes o PDF não sai pela API: pdf_available vem a false, reason diz porquê e url leva à factura no portal, onde a pode ver e guardar.

Pagamento com saldo

POST /v1/invoices/{id}/pay paga o que falta de uma factura por pagar, só com o saldo da conta. Se o saldo não chegar, responde 402 e nada é cobrado.

curl

curl -X POST "https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());
  • Precisa do cabeçalho Idempotency-Key: repetir o pedido com a mesma chave não cobra outra vez. Veja Repetições.
  • O total da factura conta para o limite de gastos da chave. Se o passar, responde 403 com spending_limit_exceeded, antes de cobrar.
  • Confira status e amount_charged na resposta. Se a factura já tiver sido paga entretanto, amount_charged vem a 0.
  • Com uma chave sandbox_, credit_sufficient e within_spending_limit dizem se o pagamento passaria. Nada é cobrado.

Saldo e transacções

Encomendas e cotações

Mudar o ciclo de renovação

A mudança vale para a próxima renovação: nada se cobra agora e a data de vencimento não muda.

  1. Veja os ciclos à venda e o preço de cada um com GET /v1/services/{id}/billing-cycles. Aqui nada muda.
  2. Peça a mudança com PUT /v1/services/{id}/billing-cycle, com o preço que viu em expected_amount. Se o preço tiver mudado, responde 409 com price_changed e nada é alterado.

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"cycle": "annually", "expected_amount": 3500.0}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"cycle": "annually", "expected_amount": 3500.0}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"cycle": "annually", "expected_amount": 3500.0}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"cycle": "annually", "expected_amount": 3500.0}),
});
console.log(response.status);
console.log(await response.text());

Se já houver uma factura por pagar deste serviço, pague-a primeiro: a API responde 409 com invoice_open e o invoice_id em details.

Em dois casos o ciclo não muda pela API, e nada é alterado:

  • VPS ou servidor: responde 409 com vps_not_supported, porque o valor pode incluir extras, como IP ou disco.
  • Preço próprio: se o valor do serviço não bater com o preço de lista do ciclo actual, responde 409 com custom_price, para não se perder o preço que tem.

Trate estes casos no portal ou com o suporte. A consulta já o mostra: can_change vem a false, blocked_reason diz porquê e cycles vem vazio. Um ciclo em que uma opção paga do serviço não tenha preço não está à venda e não aparece na lista.

Fazer um upgrade

GET /v1/services/{id}/upgrade-link devolve a ligação para o portal, onde escolhe o plano novo e vê o valor antes de pagar.

Cancelamentos

POST /v1/services/{id}/cancellation regista o pedido para o fim do período pago, nunca de imediato. O serviço continua activo até à data de service_ends_at.

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"reason": "I no longer need this plan", "confirm": "example.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"reason": "I no longer need this plan", "confirm": "example.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"reason": "I no longer need this plan", "confirm": "example.co.mz"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"reason": "I no longer need this plan", "confirm": "example.co.mz"}),
});
console.log(response.status);
console.log(await response.text());
  • Em reason, escreva o motivo.
  • Em confirm, escreva o domínio do serviço ou, se não tiver, o nome do plano.
  • As facturas por pagar do serviço podem ser canceladas.
  • Um serviço sem período pago em curso, como um gratuito ou um em atraso, responde 409 com no_period_end. Nesse caso, fale com o suporte.

O que está previsto

Operações

14 operações nesta área. Clique numa operação para ver os parâmetros, os exemplos e as respostas, ou para a experimentar no Playground, sem sair da página.

GET

Listar as facturas

/v1/invoices
GEThttps://api.mozout.com/v1/invoices

Precisa de billing:read. Primeiro as mais recentes. total inclui o que foi pago com saldo; balance_due é o que falta pagar.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusconsultastring: unpaid, paid, cancelled, refunded, collections, payment_pendingnãoSó os resultados neste estado.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/invoices" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/invoices", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar as facturas.

{
  "data": [
    {
      "id": 1042,
      "number": "0542/2026",
      "status": "unpaid",
      "date": "2026-11-01",
      "due_date": "2026-11-15",
      "paid_at": null,
      "subtotal": 3600.0,
      "tax": 0.0,
      "credit_applied": 100.0,
      "total": 3600.0,
      "balance_due": 3500.0,
      "currency": "USD",
      "payment_method": "M-Pesa",
      "url": "https://my.example.com/viewinvoice.php?id=1042&language=portuguese&currency=1"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver uma factura

/v1/invoices/{id}
GEThttps://api.mozout.com/v1/invoices/{id}

Precisa de billing:read. Com as linhas da factura.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id da factura.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver uma factura.

{
  "data": {
    "id": 1042,
    "number": "0542/2026",
    "status": "unpaid",
    "date": "2026-11-01",
    "due_date": "2026-11-15",
    "paid_at": null,
    "subtotal": 3600.0,
    "tax": 0.0,
    "credit_applied": 100.0,
    "total": 3600.0,
    "balance_due": 3500.0,
    "currency": "USD",
    "payment_method": "M-Pesa",
    "url": "https://my.example.com/viewinvoice.php?id=1042&language=portuguese&currency=1",
    "items": [
      {
        "id": 5,
        "type": "Hosting",
        "related_id": 88,
        "description": "Plano Empresas (01/11/2026 - 31/10/2027)",
        "amount": 3600.0,
        "taxed": false
      }
    ],
    "notes": ""
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver o saldo

/v1/billing/credit
GEThttps://api.mozout.com/v1/billing/credit

Precisa de billing:read. O saldo disponível na conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/billing/credit" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/billing/credit');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/billing/credit", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/billing/credit", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver o saldo.

{
  "data": {
    "balance": 250.0,
    "currency": "USD"
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar as transacções

/v1/billing/transactions
GEThttps://api.mozout.com/v1/billing/transactions

Precisa de billing:read. Os pagamentos e devoluções da conta, primeiro os mais recentes.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/billing/transactions" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/billing/transactions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/billing/transactions", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/billing/transactions", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar as transacções.

{
  "data": [
    {
      "id": 300,
      "date": "2026-11-02T10:15:00+02:00",
      "description": "Pagamento da factura 0542/2026",
      "amount_in": 3500.0,
      "amount_out": 0.0,
      "currency": "USD",
      "invoice_id": 1042,
      "payment_method": "M-Pesa",
      "transaction_id": "ABC123"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Obter o PDF de uma factura

/v1/invoices/{id}/pdf
GEThttps://api.mozout.com/v1/invoices/{id}/pdf

Precisa de billing:read. O PDF vem em content, em base64. Quando pdf_available é false, use url; reason diz porquê: internal_text, temporary_address, not_generated ou too_large. Limite de 20 por minuto.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id da factura.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pdf" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pdf');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pdf", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pdf", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Obter o PDF de uma factura.

{
  "data": {
    "pdf_available": true,
    "filename": "invoice-0669-2026.pdf",
    "content_type": "application/pdf",
    "encoding": "base64",
    "size_bytes": 29556,
    "content": "JVBERi0xLjcK",
    "invoice_id": 3127,
    "number": "0669/2026",
    "url": "https://my.example.co.mz/viewinvoice.php?id=3127&language=portuguese-mz&currency=1",
    "reason": null
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Pagar uma factura com saldo

/v1/invoices/{id}/pay
POSThttps://api.mozout.com/v1/invoices/{id}/pay

Precisa de billing:pay. Paga o que falta, só com o saldo da conta. Precisa do cabeçalho Idempotency-Key. O total da factura conta para o limite de gastos da chave. Limite de 5 por minuto, junto com as compras de domínios e de extras. Em conflict, details.reason pode ser invoice_not_unpaid, credit_not_allowed, nothing_to_pay ou profile_incomplete.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:pay.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id da factura.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/invoices/00000000-0000-4000-8000-000000000000/pay", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Pagar uma factura com saldo.

{
  "data": {
    "status": "paid",
    "amount_charged": 229.68,
    "balance_due": 0.0,
    "credit_balance": 770.32,
    "simulated": false,
    "invoice_id": 3127,
    "invoice_total": 229.68,
    "currency": "USD",
    "url": "https://my.example.co.mz/viewinvoice.php?id=3127&language=portuguese-mz&currency=1"
  },
  "meta": {}
}
CampoTipoDescrição
data.credit_sufficientbooleanSó em Sandbox: o saldo chegaria.
data.within_spending_limitbooleanSó em Sandbox: o pagamento caberia no limite de gastos da chave.
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

402

Saldo insuficiente. Nada foi cobrado.

{
  "error": {
    "code": "insufficient_credit",
    "message": "The account does not have enough credit. Nothing was charged.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "amount": 1900.0,
      "currency": "USD"
    }
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
402insufficient_creditSaldo insuficiente. Nada foi cobrado.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar as encomendas

/v1/orders
GEThttps://api.mozout.com/v1/orders

Precisa de billing:read. Primeiro as mais recentes.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusconsultastringnãoFiltra pelo estado: pending, active, cancelled ou fraud.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/orders" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/orders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/orders", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/orders", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar as encomendas.

{
  "data": [
    {
      "id": 961,
      "number": "7794007796",
      "status": "active",
      "date": "2026-10-31T14:20:18+02:00",
      "amount": 2900.93,
      "currency": "USD",
      "payment_method": "M-Pesa",
      "invoice_id": 3100,
      "promo_code": null
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver uma encomenda

/v1/orders/{id}
GEThttps://api.mozout.com/v1/orders/{id}

Precisa de billing:read. Com o que veio na encomenda: serviços, domínios, adicionais e upgrades. O endereço temporário só aparece com o serviço activo.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id da encomenda.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/orders/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/orders/00000000-0000-4000-8000-000000000000');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/orders/00000000-0000-4000-8000-000000000000", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/orders/00000000-0000-4000-8000-000000000000", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver uma encomenda.

{
  "data": {
    "id": 961,
    "number": "7794007796",
    "status": "active",
    "date": "2026-10-31T14:20:18+02:00",
    "amount": 2900.93,
    "currency": "USD",
    "payment_method": "M-Pesa",
    "invoice_id": 3100,
    "promo_code": null,
    "items": [
      {
        "type": "service",
        "id": 695,
        "name": "Plano Pro",
        "domain": "example.co.mz",
        "status": "active",
        "billing_cycle": "annually",
        "first_payment": 2900.93,
        "recurring_amount": 2900.93
      }
    ]
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar as cotações

/v1/quotes
GEThttps://api.mozout.com/v1/quotes

Precisa de billing:read. Só as cotações entregues à conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusconsultastringnãoFiltra pelo estado: delivered, accepted, lost ou dead.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/quotes" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/quotes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/quotes", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/quotes", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar as cotações.

{
  "data": [
    {
      "id": 15,
      "subject": "Website",
      "status": "delivered",
      "created_at": "2026-10-01",
      "sent_at": "2026-10-01",
      "valid_until": "2026-11-01",
      "accepted_at": null,
      "subtotal": 28000.0,
      "tax": 4559.0,
      "total": 32559.0,
      "currency": "USD",
      "url": "https://my.example.co.mz/viewquote.php?id=15&language=portuguese-mz&currency=1"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver uma cotação

/v1/quotes/{id}
GEThttps://api.mozout.com/v1/quotes/{id}

Precisa de billing:read. Com a proposta, as notas para si e as linhas.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id da cotação.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/quotes/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/quotes/00000000-0000-4000-8000-000000000000');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/quotes/00000000-0000-4000-8000-000000000000", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/quotes/00000000-0000-4000-8000-000000000000", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver uma cotação.

{
  "data": {
    "id": 15,
    "subject": "Website",
    "status": "delivered",
    "created_at": "2026-10-01",
    "sent_at": "2026-10-01",
    "valid_until": "2026-11-01",
    "accepted_at": null,
    "subtotal": 28000.0,
    "tax": 4559.0,
    "total": 32559.0,
    "currency": "USD",
    "url": "https://my.example.co.mz/viewquote.php?id=15&language=portuguese-mz&currency=1",
    "proposal": "Proposal text",
    "notes": "Notes for you",
    "items": [
      {
        "id": 1,
        "description": "Website",
        "quantity": 1.0,
        "unit_price": 28000.0,
        "discount_percent": 0.0,
        "taxed": true
      }
    ]
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver os ciclos de renovação de um serviço

/v1/services/{id}/billing-cycles
GEThttps://api.mozout.com/v1/services/{id}/billing-cycles

Precisa de billing:read. Só os ciclos à venda, com o preço de cada renovação. Um ciclo em que uma opção paga do serviço não tem preço não está à venda. Nada muda. blocked_reason diz porque não se pode mudar agora: service_not_active, vps_not_supported, no_cycles, custom_price ou invoice_open. Com vps_not_supported ou custom_price, cycles vem vazio: trate a mudança no portal ou com o suporte.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycles" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycles');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycles", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycles", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver os ciclos de renovação de um serviço.

{
  "data": {
    "service_id": 695,
    "current_cycle": "monthly",
    "current_amount": 350.0,
    "currency": "USD",
    "next_due_date": "2026-12-20",
    "can_change": true,
    "blocked_reason": null,
    "invoice_id": null,
    "cycles": [
      {
        "cycle": "annually",
        "amount": 3500.0,
        "current": false
      }
    ]
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

PUT

Mudar o ciclo da próxima renovação

/v1/services/{id}/billing-cycle
PUThttps://api.mozout.com/v1/services/{id}/billing-cycle

Precisa de billing:write. Nada se cobra agora e a próxima data de vencimento não muda. Indique em expected_amount o preço da consulta: se tiver mudado, responde 409 com price_changed. Um VPS ou servidor responde 409 com vps_not_supported, e um serviço cujo valor não bate com o preço de lista do ciclo actual responde 409 com custom_price: trate-os no portal ou com o suporte. Limite de 20 por minuto.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
cyclestring: monthly, quarterly, semi_annually, annually, biennially, trienniallysim
expected_amountnumbersimO preço da consulta.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"cycle": "annually", "expected_amount": 3500.0}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"cycle": "annually", "expected_amount": 3500.0}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"cycle": "annually", "expected_amount": 3500.0}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/billing-cycle", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"cycle": "annually", "expected_amount": 3500.0}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar o ciclo da próxima renovação.

{
  "data": {
    "service_id": 695,
    "previous_cycle": "monthly",
    "cycle": "annually",
    "amount": 3500.0,
    "currency": "USD",
    "applies_from": "2026-12-20",
    "simulated": true
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Obter a ligação de upgrade de um serviço

/v1/services/{id}/upgrade-link
GEThttps://api.mozout.com/v1/services/{id}/upgrade-link

Precisa de billing:read. Nessa página escolhe o plano novo e vê o valor antes de pagar. Aqui nada muda.

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: billing:read.

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/upgrade-link" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/upgrade-link');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/upgrade-link", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/upgrade-link", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());
EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Pedir o cancelamento de um serviço

/v1/services/{id}/cancellation
POSThttps://api.mozout.com/v1/services/{id}/cancellation

Precisa de services:cancel. Sempre no fim do período pago, nunca de imediato. O serviço continua activo até service_ends_at. Um serviço sem período pago em curso responde 409 com no_period_end: fale com o suporte. As facturas por pagar do serviço podem ser canceladas. Limite de 5 por hora.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: services:cancel.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.
Idempotency-KeycabeçalhostringnãoIdentificador único deste pedido, para o repetir sem o duplicar.

Corpo do pedido

CampoTipoObrigatórioDescrição
reasonstringsimO motivo do cancelamento.
confirmstringsimO domínio do serviço ou, se não tiver, o nome do plano.
typestring: end_of_billing_periodnão

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"reason": "I no longer need this plan", "confirm": "example.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"reason": "I no longer need this plan", "confirm": "example.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"reason": "I no longer need this plan", "confirm": "example.co.mz"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cancellation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"reason": "I no longer need this plan", "confirm": "example.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Pedir o cancelamento de um serviço.

{
  "data": {
    "status": "requested",
    "service_id": 695,
    "type": "end_of_billing_period",
    "service_ends_at": "2026-12-20",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.