Referência da API

Planos

A lista pública de planos, preços e limites.

A lista pública de planos, a mesma usada na página de preços. Não precisa de chave de API.

#Listar planos

GET/plans

Público, sem chave

Planos ativos e públicos, na ordem de exibição. kind é transactional (envio) ou marketing (contatos e campanhas). Preços em prices estão em centavos, por moeda (brl, usd) e intervalo; overage_prices é o preço por mil e-mails além da cota, quando o plano permite (allows_overage). Nos limits, null é ilimitado e rate_limit é o número de requisições por segundo.

GET /plans

cURL

curl https://api.postal.so/plans

Node.js

const response = await fetch('https://api.postal.so/plans');

const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.postal.so/plans",
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->get('plans');

$data = json_decode($response->getBody(), true);

200Resposta (valores ilustrativos)

{
  "object": "list",
  "data": [
    {
      "object": "plan",
      "id": "0199e000-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
      "kind": "transactional",
      "slug": "pro",
      "name": "Pro",
      "description": "Para produtos em produção com volume constante.",
      "features": [
        "50.000 e-mails por mês",
        "Sem limite diário",
        "10 domínios"
      ],
      "limits": {
        "emails_per_month": 50000,
        "emails_per_day": null,
        "domains": 10,
        "inboxes": 10,
        "custom_inbound_domains": 1,
        "postal_branding": 0,
        "team_members": 10,
        "automation_runs": 10000,
        "ai_credits": 100,
        "rate_limit": 10
      },
      "allows_overage": true,
      "trial_days": 0,
      "is_default": false,
      "prices": [
        {
          "id": "0199e000-2b3c-7d4e-8f5a-6b7c8d9e0f1a",
          "currency": "brl",
          "interval": "month",
          "amount": 9900
        },
        {
          "id": "0199e000-2b3d-7e5f-9a6b-7c8d9e0f1a2b",
          "currency": "usd",
          "interval": "month",
          "amount": 2000
        }
      ],
      "overage_prices": {
        "brl": 450,
        "usd": 90
      }
    }
  ]
}