Get message rates - Pilot Status

GET

/

v1

/

meta

/

pricing

Message rate

curl --request GET \
  --url https://pilotstatus.com.br/v1/meta/pricing \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/meta/pricing', 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/meta/pricing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/meta/pricing"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/meta/pricing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "market": "BR",
  "marketName": "Brazil",
  "currency": "BRL",
  "category": "authentication",
  "pricePerMessage": 0.035
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Query Parameters

market

enum<string>

Market code. Codes: AR Argentina, BR Brazil, CL Chile, CO Colombia, EG Egypt, FR France, DE Germany, HK Hong Kong, HU Hungary, IN India, ID Indonesia, IL Israel, IT Italy, MY Malaysia, MX Mexico, NL Netherlands, NG Nigeria, NAM North America, PK Pakistan, PE Peru, PL Poland, QA Qatar, RO Romania, RU Russia, SA Saudi Arabia, SG Singapore, ZA South Africa, ES Spain, TR Turkey, AE United Arab Emirates, GB United Kingdom, GLO Other, AFR Rest of Africa, APAC Rest of Asia Pacific, CEEU Rest of Central & Eastern Europe, LATAM Rest of Latin America, MDE Rest of Middle East, WEU Rest of Western Europe.

Available options:

AR,

BR,

CL,

CO,

EG,

FR,

DE,

HK,

HU,

IN,

ID,

IL,

IT,

MY,

MX,

NL,

NG,

NAM,

PK,

PE,

PL,

QA,

RO,

RU,

SA,

SG,

ZA,

ES,

TR,

AE,

GB,

GLO,

AFR,

APAC,

CEEU,

LATAM,

MDE,

WEU

currency

enum<string>

ISO 4217 currency.

Available options:

USD,

AED,

ARS,

AUD,

BRL,

CLP,

COP,

EUR,

GBP,

IDR,

INR,

MXN,

MYR,

PEN,

SAR,

SGD

category

enum<string>

Message category (required together with market + currency).

Available options:

marketing,

utility,

authentication,

service,

authentication_international

tiers

boolean

Include the volume tiers (cheaper price at higher monthly volume) in the response.

Response

The flat price for the market+currency+category, or metadata when called with no params.

Price
Metadata

market

string

marketName

string

currency

string

category

enum<string>

Available options:

marketing,

utility,

authentication,

service,

authentication_international

pricePerMessage

number

List price per delivered message in the requested currency. 0 = free (Service).

volumeTiers

object[]

Only present with tiers=true. Cheaper price at higher monthly volume.

Show child attributes

Message rate

curl --request GET \
  --url https://pilotstatus.com.br/v1/meta/pricing \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/meta/pricing', 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/meta/pricing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/meta/pricing"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/meta/pricing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "market": "BR",
  "marketName": "Brazil",
  "currency": "BRL",
  "category": "authentication",
  "pricePerMessage": 0.035
}