Subscription
Buy an extra number (On Demand)
Buys N extra number(s). Requires a TENANT-scoped key. A Free tenant is converted to On Demand (bills the converted free number + the new one) — requires confirm:true, otherwise returns 409 CONFIRMATION_REQUIRED with the preview. The prorated cost is charged immediately — wallet credits first, the remainder on the saved card (Plans → Cartão). It never returns a checkout link: with neither enough credits nor a saved card it returns 402 INSUFFICIENT_FUNDS and charges nothing; a declined card is 402 PAYMENT_FAILED; a processor failure is 502 PAYMENT_PROVIDER_ERROR. Real side effect: it charges. Stripe only.
Requires a tenant-scoped key.
POST
/
v1
/
subscription
/
extra-numbers
Buy an extra number (On Demand)
curl --request POST \
--url https://pilotstatus.com.br/v1/subscription/extra-numbers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quantity": "1",
"confirm": "true"
}
'import requests
url = "https://pilotstatus.com.br/v1/subscription/extra-numbers"
payload = {
"quantity": "1",
"confirm": "true"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({quantity: '1', confirm: 'true'})
};
fetch('https://pilotstatus.com.br/v1/subscription/extra-numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/subscription/extra-numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => '1',
'confirm' => 'true'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/subscription/extra-numbers"
payload := strings.NewReader("{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/subscription/extra-numbers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/subscription/extra-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"charged": true,
"plan": "ON_DEMAND",
"paidExtraNumbers": 3,
"proratedTotal": 14.95,
"currency": "BRL",
"creditsUsed": 10,
"cardCharged": 4.95,
"monthlyTotalBRL": 29.9
}Authorizations
apiKeyapiKeyId
Your ps_ API key
Body
application/json
Response
Bought 1 extra number on a plan that is already On Demand, with half the cycle left. The prorated cost was taken from wallet credits first and the rest from the saved card (creditsUsed + cardCharged = proratedTotal); paidExtraNumbers already counts the new slot. plan is the plan the account had before this call, and monthlyTotalBRL prices only the quantity you asked for: on a Free → On Demand conversion they read FREE and 1 × the unit price, although 2 numbers are billed from then on.
Was this page helpful?
⌘I
Buy an extra number (On Demand)
curl --request POST \
--url https://pilotstatus.com.br/v1/subscription/extra-numbers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quantity": "1",
"confirm": "true"
}
'import requests
url = "https://pilotstatus.com.br/v1/subscription/extra-numbers"
payload = {
"quantity": "1",
"confirm": "true"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({quantity: '1', confirm: 'true'})
};
fetch('https://pilotstatus.com.br/v1/subscription/extra-numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/subscription/extra-numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => '1',
'confirm' => 'true'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/subscription/extra-numbers"
payload := strings.NewReader("{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/subscription/extra-numbers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/subscription/extra-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": \"1\",\n \"confirm\": \"true\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"charged": true,
"plan": "ON_DEMAND",
"paidExtraNumbers": 3,
"proratedTotal": 14.95,
"currency": "BRL",
"creditsUsed": 10,
"cardCharged": 4.95,
"monthlyTotalBRL": 29.9
}