Extra products

Updated on 5 November 20264 min read

With a sandbox_ key, or while the API is in preparation, purchases are simulated and nothing is charged. See Sandbox and Production.

What the account has

GET /v1/extras returns the SSL certificates, SiteLock and other products, radio with its add-ons, and the extra IP and disk of servers. You can filter with kind, for example ?kind=ssl. The list comes in pages. It needs extras:read.

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/extras');
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/extras", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

GET /v1/extras/{id} shows one of them, with the id from the list. Access data, such as the radio details, never comes through the API: see it in the portal, at manage_url.

What is for sale

GET /v1/extras/catalog returns the products, with the periods and the prices in the currency of the account. purchasable says if it can be bought through the API. If it is false, use portal_url.

Buying

POST /v1/extras/purchase buys a product with purchasable. Today these are three SSL certificates (RapidSSL, GeoTrust QuickSSL Premium and DigiCert Secure Site) and SiteLock Find, Fix and Defend.

curl

curl -X POST "https://api.mozout.com/v1/extras/purchase" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"product_id": 96, "billing_cycle": "annually", "site": "example.com"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/extras/purchase');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"product_id": 96, "billing_cycle": "annually", "site": "example.com"}',
    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 = {"product_id": 96, "billing_cycle": "annually", "site": "example.com"}
r = requests.post("https://api.mozout.com/v1/extras/purchase", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/extras/purchase", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"product_id": 96, "billing_cycle": "annually", "site": "example.com"}),
});
console.log(response.status);
console.log(await response.text());

The purchase needs the billing:purchase and extras:write permissions, and the Idempotency-Key header. It is paid only with the credit of the account, within the spending limit of the key. If there is not enough credit, the price changes or the account profile is incomplete, nothing is charged.

SiteLock: give site, the domain of the site. It only has the periods shown in the catalog: never 3 or 6 months.
Certificates: they do not take site. The certificate is configured in the portal after the purchase, at manage_url, and the status comes in certificate.

The answer is 202. The action ends with the payment; follow delivery in GET /v1/extras/{id}, with the extra_id from the answer.

What is handled in the portal

Extra IP and disk of a server: they appear in the list, but they are bought on the page of the server, in the portal.
Radio and the other products in the catalog: buying them involves choices or a follow-up that only the portal does. The answer is 422 with portal_only and portal_url.

Operations

4 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 extras for sale

/v1/extras/catalog

GEThttps://api.mozout.com/v1/extras/catalog

Needs extras:read. Prices in the currency of the account. purchasable says if it can be bought through the API; if not, use portal_url. SiteLock has no 3 or 6 month periods. Extra IP and disk of a server are bought in the account portal.

Authentication

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

Parameters

Name	In	Type	Required	Description
`kind`	query	string: ssl, sitelock, website_builder, backup, email_filter, email, seo, monitoring, vpn, social, radio, radio_addon, vps_ip, vps_disk, other	no	Only this kind.
`page`	query	integer	no	The page number. The first is 1.
`per_page`	query	integer	no	Results per page, from 1 to 100. The default is 10.
`X-API-Mode`	header	string: sandbox, production	no	Optional. 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/extras/catalog" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/extras/catalog');
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/extras/catalog", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Responses

200

List extras for sale.

{
  "data": [
    {
      "id": 96,
      "kind": "sitelock",
      "name": "Fix",
      "description": "Finds and removes malware from the site.",
      "currency": "USD",
      "billing_cycles": [
        {
          "billing_cycle": "annually",
          "months": 12,
          "price": 5999.4,
          "setup_fee": 0.0
        }
      ],
      "purchasable": true,
      "requires_site": true,
      "portal_url": "https://my.example.com/onestep/billingcycle?pid=96&language=portuguese&currency=5"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Header	Description
`X-Correlation-ID`	Identifier of this request. Give it to support when you report a problem.
`X-RateLimit-Limit`	Requests allowed per minute.
`X-RateLimit-Remaining`	Requests left in the current minute.
`X-RateLimit-Reset`	When the minute ends, as a Unix timestamp in seconds.
`X-API-Mode`	The 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
    }
  }
}

Header	Description
`Retry-After`	Seconds 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

Status	Code	Meaning
401	`unauthorized`	The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	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`).
422	`validation_failed`	Some of the data is not valid.
429	`rate_limited`	Too many requests. Wait for the time in Retry-After.
500	`internal_error`	An internal error occurred. Give the correlation_id to support.
503	`disabled`	The API is turned off.

The error format is explained in Errors.

GET

List the extras of the account

/v1/extras

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

Needs extras:read. The extras of this account. The id starts with s for a service, a for an add-on and v for an extra IP or disk of a server, which also has quantity and invoice_id. Certificates have certificate. Access data never comes here.

Authentication

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

Parameters

Name	In	Type	Required	Description
`kind`	query	string: ssl, sitelock, website_builder, backup, email_filter, email, seo, monitoring, vpn, social, radio, radio_addon, vps_ip, vps_disk, other	no	Only this kind.
`page`	query	integer	no	The page number. The first is 1.
`per_page`	query	integer	no	Results per page, from 1 to 100. The default is 10.
`X-API-Mode`	header	string: sandbox, production	no	Optional. 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/extras" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/extras');
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/extras", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Responses

200

List the extras of the account.

{
  "data": [
    {
      "id": "s812",
      "kind": "ssl",
      "name": "RapidSSL",
      "status": "active",
      "site": null,
      "parent_service_id": null,
      "billing_cycle": "annually",
      "amount": 1077.0,
      "currency": "USD",
      "next_due_date": "2027-11-05",
      "registered_at": "2026-11-05",
      "manage_url": "https://my.example.com/clientarea.php?action=productdetails&id=812&language=portuguese&currency=5",
      "certificate": {
        "status": "awaiting_configuration",
        "expires_at": null
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Header	Description
`X-Correlation-ID`	Identifier of this request. Give it to support when you report a problem.
`X-RateLimit-Limit`	Requests allowed per minute.
`X-RateLimit-Remaining`	Requests left in the current minute.
`X-RateLimit-Reset`	When the minute ends, as a Unix timestamp in seconds.
`X-API-Mode`	The 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
    }
  }
}

Header	Description
`Retry-After`	Seconds 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

Status	Code	Meaning
401	`unauthorized`	The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	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`).
422	`validation_failed`	Some of the data is not valid.
429	`rate_limited`	Too many requests. Wait for the time in Retry-After.
500	`internal_error`	An internal error occurred. Give the correlation_id to support.
503	`disabled`	The API is turned off.

The error format is explained in Errors.

GET

See an extra

/v1/extras/{id}

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

Needs extras:read. One extra of this account, with the id from the list.

Authentication

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

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	The `id` from the list, such as `s812`.
`X-API-Mode`	header	string: sandbox, production	no	Optional. 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/extras/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/extras/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/extras/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/extras/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 extra.

{
  "data": {
    "id": "s812",
    "kind": "ssl",
    "name": "RapidSSL",
    "status": "active",
    "site": null,
    "parent_service_id": null,
    "billing_cycle": "annually",
    "amount": 1077.0,
    "currency": "USD",
    "next_due_date": "2027-11-05",
    "registered_at": "2026-11-05",
    "manage_url": "https://my.example.com/clientarea.php?action=productdetails&id=812&language=portuguese&currency=5",
    "certificate": {
      "status": "awaiting_configuration",
      "expires_at": null
    }
  },
  "meta": {}
}

Header	Description
`X-Correlation-ID`	Identifier of this request. Give it to support when you report a problem.
`X-RateLimit-Limit`	Requests allowed per minute.
`X-RateLimit-Remaining`	Requests left in the current minute.
`X-RateLimit-Reset`	When the minute ends, as a Unix timestamp in seconds.
`X-API-Mode`	The 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
    }
  }
}

Header	Description
`Retry-After`	Seconds 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

Status	Code	Meaning
401	`unauthorized`	The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	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`).
404	`not_found`	Not found.
429	`rate_limited`	Too many requests. Wait for the time in Retry-After.
500	`internal_error`	An internal error occurred. Give the correlation_id to support.
503	`disabled`	The API is turned off.

The error format is explained in Errors.

POST

Buy an extra

/v1/extras/purchase

POSThttps://api.mozout.com/v1/extras/purchase

Needs billing:purchase. Also needs extras:write and the Idempotency-Key header. Paid with credit only, within the spending limit of the key. Only for products with purchasable. SiteLock needs site; a certificate does not take it and is configured in the portal after the purchase. Answers 202: the action ends with the payment, and delivery is followed in GET /v1/extras/{id}. Limited to 5 per minute.

Authentication

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

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	Any 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-Mode`	header	string: sandbox, production	no	Optional. 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

Field	Type	Required	Description
`product_id`	integer	yes	The `id` from the catalog.
`billing_cycle`	string: monthly, annually, biennially, triennially	yes
`site`	string	no	The domain of the site. Only for SiteLock.

Examples

curl

curl -X POST "https://api.mozout.com/v1/extras/purchase" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"product_id": 96, "billing_cycle": "annually", "site": "example.com"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/extras/purchase');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"product_id": 96, "billing_cycle": "annually", "site": "example.com"}',
    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 = {"product_id": 96, "billing_cycle": "annually", "site": "example.com"}
r = requests.post("https://api.mozout.com/v1/extras/purchase", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/extras/purchase", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"product_id": 96, "billing_cycle": "annually", "site": "example.com"}),
});
console.log(response.status);
console.log(await response.text());

Responses

202

Buy an extra.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "simulated",
    "simulated": true,
    "product_id": 96,
    "name": "Fix",
    "billing_cycle": "annually",
    "site": "example.com",
    "amount": 5999.4,
    "currency": "USD",
    "credit_sufficient": true,
    "within_spending_limit": true
  },
  "meta": {}
}

Header	Description
`X-Correlation-ID`	Identifier of this request. Give it to support when you report a problem.
`X-RateLimit-Limit`	Requests allowed per minute.
`X-RateLimit-Remaining`	Requests left in the current minute.
`X-RateLimit-Reset`	When the minute ends, as a Unix timestamp in seconds.
`X-API-Mode`	The 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"
    }
  }
}

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
    }
  }
}

Header	Description
`Retry-After`	Seconds 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

Status	Code	Meaning
400	`invalid_request`	The request is not valid, for example the body is not JSON or the connection is not HTTPS.
401	`unauthorized`	The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
402	`insufficient_credit`	Not enough credit. Nothing was charged.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	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`).
409	`conflict`	The operation cannot be done in the current state. See `details.reason`.
422	`validation_failed`	Some of the data is not valid.
429	`rate_limited`	Too many requests. Wait for the time in Retry-After.
500	`internal_error`	An internal error occurred. Give the correlation_id to support.
502	`upstream_error`	The service behind the API did not respond as expected.
503	`disabled`	The API is turned off.

The error format is explained in Errors.