Skip to main content
GET
/
plans
Listar Planos
curl --request GET \
  --url https://api.example.com/plans \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
      "externalRef": "prod_stripe_abc",
      "name": "Starter",
      "description": "Perfect for small teams getting started.",
      "features": [
        { "description": "Up to 5 users", "type": "INCLUDE" },
        { "description": "Basic analytics", "type": "INCLUDE" },
        { "description": "Custom integrations", "type": "NOT_INCLUDE" }
      ],
      "intervals": [
        {
          "id": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
          "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
          "interval": "MONTHLY",
          "amount": 4900,
          "currency": "BRL",
          "status": "ACTIVE",
          "externalRef": "price_stripe_monthly",
          "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        },
        {
          "id": "019525fd-8f54-7d6b-c3e9-5f7a9b1c3d5f",
          "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
          "interval": "YEARLY",
          "amount": 47040,
          "currency": "BRL",
          "status": "ACTIVE",
          "externalRef": "price_stripe_yearly",
          "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "highlight": false,
      "status": "ACTIVE",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "totalItems": 3,
    "totalPages": 1,
    "page": 1,
    "limit": 20
  }
}
Retorna uma lista de planos. 
curl "https://api.awsales.io/studio/plans?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao plan:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Consulta

​
page
integer
Numero da pagina para paginacao.
​
limit
integer
Numero de resultados por pagina.
​
sort
string
Campo e direcao de ordenacao (ex.: name:asc).
​
name
string
Filtrar planos por nome.
​
status
string
Filtrar planos por status (ex.: ACTIVE).

​
Resposta

​
data
array
Array de objetos de plano.
​
meta
object
Metadados de paginacao.
{
  "data": [
    {
      "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
      "externalRef": "prod_stripe_abc",
      "name": "Starter",
      "description": "Perfect for small teams getting started.",
      "features": [
        { "description": "Up to 5 users", "type": "INCLUDE" },
        { "description": "Basic analytics", "type": "INCLUDE" },
        { "description": "Custom integrations", "type": "NOT_INCLUDE" }
      ],
      "intervals": [
        {
          "id": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
          "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
          "interval": "MONTHLY",
          "amount": 4900,
          "currency": "BRL",
          "status": "ACTIVE",
          "externalRef": "price_stripe_monthly",
          "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        },
        {
          "id": "019525fd-8f54-7d6b-c3e9-5f7a9b1c3d5f",
          "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
          "interval": "YEARLY",
          "amount": 47040,
          "currency": "BRL",
          "status": "ACTIVE",
          "externalRef": "price_stripe_yearly",
          "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "highlight": false,
      "status": "ACTIVE",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "totalItems": 3,
    "totalPages": 1,
    "page": 1,
    "limit": 20
  }
}
Valores estao em centavos (ex.: 4900 = R$49,00).

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
500internal_server_errorOcorreu um erro inesperado