Skip to main content
GET
/
plans
/
{planId}
Buscar Plano
curl --request GET \
  --url https://api.example.com/plans/{planId} \
  --header 'Authorization: <authorization>'
{
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "externalRef": "prod_stripe_abc",
  "name": "Starter",
  "description": "For small teams.",
  "features": [
    { "description": "Up to 5 users", "type": "INCLUDE" }
  ],
  "intervals": [
    { "planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a", "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f", "externalRef": "price_stripe_m1", "interval": "MONTHLY", "amount": 4900, "currency": "BRL", "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" }
  ],
  "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"
}
Requer permissao plan:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
planId
string
required
ID do plano.

​
Resposta

​
planId
string
ID do plano.
​
externalRef
string
Referencia externa.
​
name
string
Nome do plano.
​
description
string
Descricao do plano.
​
features
array
Funcionalidades do plano.
​
intervals
array
Intervalos de billing.
​
highlight
boolean
Se o plano e destacado.
​
status
string
Status do plano.
​
createdBy
string
ID do usuario que criou o plano.
​
createdAt
string
Timestamp de criacao.
​
updatedBy
string
ID do usuario que atualizou o plano por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao.
{
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "externalRef": "prod_stripe_abc",
  "name": "Starter",
  "description": "For small teams.",
  "features": [
    { "description": "Up to 5 users", "type": "INCLUDE" }
  ],
  "intervals": [
    { "planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a", "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f", "externalRef": "price_stripe_m1", "interval": "MONTHLY", "amount": 4900, "currency": "BRL", "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" }
  ],
  "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"
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/plans/019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404plan.not_foundPlano nao encontrado
500internal_server_errorOcorreu um erro inesperado