Invoices and credit

See invoices and pay them with credit, see orders and quotes, change the renewal cycle and request a cancellation through the API.

See the operationsPlayground
On this page
  1. Documentation
    2.  » 
  2. Invoices and credit
Updated on 8 min read
View as Markdown

The API reads invoices, credit, orders and quotes, pays invoices with the credit of the account, changes the cycle of the next renewal and records cancellation requests. It only charges credit: to pay another way, use My MozOut or the url of each invoice.

What you need

ToPermission
Read invoices, orders and quotes, see cycles and get the upgrade linkbilling:read
Change the cycle of the next renewalbilling:write
Pay with creditbilling:pay, a dangerous permission
Request the cancellation of a serviceservices:cancel, a dangerous permission

With a sandbox_ key, or while the API is being prepared, changes are simulated and nothing is charged. See Sandbox and Production. Services are in Hosting.

The list of invoices

GET /v1/invoices returns the invoices of the account, the newest first. You can filter with status, for example ?status=unpaid. The list comes in pages.

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

The amounts of an invoice

FieldWhat it is
totalThe invoice total, including what was paid with credit.
credit_appliedWhat was paid with credit.
balance_dueWhat is still to pay.

GET /v1/invoices/{id} also returns the lines of the invoice.

Download the PDF

GET /v1/invoices/{id}/pdf returns the PDF in content, in base64. Sometimes the PDF does not come through the API: pdf_available is false, reason says why and url leads to the invoice in the portal, where you can see and save it.

Paying with credit

POST /v1/invoices/{id}/pay pays what is still due on an unpaid invoice, with the credit of the account only. If the credit is not enough, it answers 402 and nothing is charged.

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: en" \
  -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: en',
        '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": "en",
    "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": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());
  • It needs the Idempotency-Key header: repeating the request with the same key does not charge again. See Idempotency.
  • The invoice total counts towards the spending limit of the key. If it goes over, it answers 403 with spending_limit_exceeded, before charging.
  • Check status and amount_charged in the response. If the invoice was paid in the meantime, amount_charged is 0.
  • With a sandbox_ key, credit_sufficient and within_spending_limit say if the payment would go through. Nothing is charged.

Credit and transactions

Orders and quotes

Change the renewal cycle

The change applies to the next renewal: nothing is charged now and the due date stays.

  1. See the cycles on sale and the price of each with GET /v1/services/{id}/billing-cycles. Nothing changes here.
  2. Ask for the change with PUT /v1/services/{id}/billing-cycle, with the price you saw in expected_amount. If the price changed, it answers 409 with price_changed and nothing is changed.

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: en" \
  -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: en',
        '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": "en",
}
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": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"cycle": "annually", "expected_amount": 3500.0}),
});
console.log(response.status);
console.log(await response.text());

If there is already an unpaid invoice for this service, pay it first: the API answers 409 with invoice_open and its number.

In two cases the cycle does not change through the API, and nothing is changed:

  • VPS or server: it answers 409 with vps_not_supported, because the amount can include extras, such as an IP or disk.
  • Custom price: if the amount of the service does not match the list price of its current cycle, it answers 409 with custom_price, so the price it has is not lost.

Handle these cases in the portal or with support. The query already shows it: can_change is false, blocked_reason says why and cycles is empty. A cycle where a paid option of the service has no price is not on sale and does not appear in the list.

Upgrade

GET /v1/services/{id}/upgrade-link returns the link to the portal, where you choose the new plan and see the amount before paying.

Cancellations

POST /v1/services/{id}/cancellation records the request for the end of the paid period, never right away. The service stays active until the date in 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: en" \
  -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: en',
        '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": "en",
    "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": "en",
    "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());
  • In reason, write why.
  • In confirm, write the domain of the service or, if it has none, the plan name.
  • Unpaid invoices of the service can be cancelled.
  • A service with no paid period still running, such as a free one or an overdue one, answers 409 with no_period_end. In that case, ask support.

What is planned

Operations

14 operations in this area. Click an operation to see its parameters, examples and responses, or to try it in the Playground, without leaving the page.

GET

List the invoices

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

Needs billing:read. The newest first. total includes what was paid with credit; balance_due is what is still to pay.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
statusquerystring: unpaid, paid, cancelled, refunded, collections, payment_pendingnoOnly results in this status.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List the invoices.

{
  "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
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See an invoice

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

Needs billing:read. With the lines of the invoice.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the invoice.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See an invoice.

{
  "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": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See the credit

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

Needs billing:read. The credit available on the account.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See the credit.

{
  "data": {
    "balance": 250.0,
    "currency": "USD"
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List the transactions

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

Needs billing:read. The payments and refunds of the account, the newest first.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List the transactions.

{
  "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
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

Get the PDF of an invoice

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

Needs billing:read. The PDF comes in content, in base64. When pdf_available is false, use url; reason says why: internal_text, temporary_address, not_generated or too_large. Limited to 20 per minute.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the invoice.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

Get the PDF of an invoice.

{
  "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": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Pay an invoice with credit

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

Needs billing:pay. Pays what is still due, with the credit of the account and nothing else. Needs the Idempotency-Key header. The invoice total counts towards the spending limit of the key. Limited to 5 per minute, shared with domain purchases. In conflict, details.reason can be invoice_not_unpaid, credit_not_allowed, nothing_to_pay or profile_incomplete.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:pay.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the invoice.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

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: en" \
  -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: en',
        '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": "en",
    "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": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

Pay an invoice with credit.

{
  "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": {}
}
FieldTypeDescription
data.credit_sufficientbooleanSandbox only: the credit would be enough.
data.within_spending_limitbooleanSandbox only: the payment would fit the spending limit of the key.
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

400

The request is not valid, for example the body is not JSON or the connection is not HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "The request is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

402

Not enough credit. Nothing was charged.

{
  "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

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See 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

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "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

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
400invalid_requestThe request is not valid, for example the body is not JSON or the connection is not HTTPS.
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
402insufficient_creditNot enough credit. Nothing was charged.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List the orders

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

Needs billing:read. The most recent first.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
statusquerystringnoFilter by status: pending, active, cancelled or fraud.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List the orders.

{
  "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
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See an order

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

Needs billing:read. With what came in the order: services, domains, addons and upgrades. A temporary address only appears when the service is active.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the order.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See an order.

{
  "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": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List the quotes

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

Needs billing:read. Only the quotes delivered to the account.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
statusquerystringnoFilter by status: delivered, accepted, lost or dead.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List the quotes.

{
  "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
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See a quote

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

Needs billing:read. With the proposal, the notes for you and the lines.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the quote.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See a quote.

{
  "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": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See the renewal cycles of a service

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

Needs billing:read. Only the cycles on sale, with the price of each renewal. A cycle where a paid option of the service has no price is not on sale. Nothing changes. blocked_reason says why it cannot change now: service_not_active, vps_not_supported, no_cycles, custom_price or invoice_open. With vps_not_supported or custom_price, cycles is empty: handle the change in the portal or with support.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See the renewal cycles of a service.

{
  "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": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

PUT

Change the cycle of the next renewal

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

Needs billing:write. Nothing is charged now and the next due date stays. Give in expected_amount the price from the query: if it changed, it answers 409 with price_changed. A VPS or server answers 409 with vps_not_supported, and a service whose amount differs from the list price of its current cycle answers 409 with custom_price: handle these in the portal or with support. Limited to 20 per minute.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: billing:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
cyclestring: monthly, quarterly, semi_annually, annually, biennially, trienniallyyes
expected_amountnumberyesThe price from the query.

Examples

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: en" \
  -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: en',
        '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": "en",
}
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": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"cycle": "annually", "expected_amount": 3500.0}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Change the cycle of the next renewal.

{
  "data": {
    "service_id": 695,
    "previous_cycle": "monthly",
    "cycle": "annually",
    "amount": 3500.0,
    "currency": "USD",
    "applies_from": "2026-12-20",
    "simulated": true
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See 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

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "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

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

Get the upgrade link of a service

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

Needs billing:read. On that page you choose the new plan and see the amount before paying. Nothing changes here.

Needs a valid key in the Authorization: Bearer header. Required permission: billing:read.

NameInTypeRequiredDescription
idpathstringyesThe id of the service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

curl

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

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: en',
    ],
]);
$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": "en",
}
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": "en",
  },
});
console.log(response.status);
console.log(await response.text());
StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Request the cancellation of a service

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

Needs services:cancel. Always at the end of the paid period, never right away. The service stays active until service_ends_at. A service with no paid period still running answers 409 with no_period_end: ask support. Unpaid invoices of the service can be cancelled. Limited to 5 per hour.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: services:cancel.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.
Idempotency-KeyheaderstringnoA unique identifier for this request, so it can be repeated without duplicating it.

Request body

FieldTypeRequiredDescription
reasonstringyesWhy you are cancelling.
confirmstringyesThe domain of the service or, if it has none, the plan name.
typestring: end_of_billing_periodno

Examples

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: en" \
  -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: en',
        '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": "en",
    "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": "en",
    "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());

Responses

201

Request the cancellation of a service.

{
  "data": {
    "status": "requested",
    "service_id": 695,
    "type": "end_of_billing_period",
    "service_ends_at": "2026-12-20",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See 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

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "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

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.