Skip to main content
Um plano define um nivel de precificacao disponivel para organizacoes. Cada plano inclui um nome, descricao, uma lista de funcionalidades (incluidas ou excluidas) e um ou mais intervalos de cobranca (mensal, anual) com seus respectivos precos. Planos sao gerenciados por administradores e exibidos para usuarios finais na pagina de precos. Voce encontrara objetos de plano ao listar niveis disponiveis ou criar assinaturas.
​
planId
string
O identificador unico do plano (UUIDv7).
​
externalRef
string
A referencia externa do plano no provedor de pagamento.
​
name
string
O nome do plano.
​
description
string
A descricao do plano.
​
features
object[]
A lista de funcionalidades incluidas no plano.
​
intervals
object[]
Os intervalos de cobranca disponiveis para o plano.
​
highlight
boolean
Se o plano esta destacado na pagina de precos.
​
status
string
O status do plano. Um de: ACTIVE, INACTIVE.
​
createdBy
string
O ID do usuario que criou o plano.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedBy
string
O ID do usuario que atualizou o plano por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "externalRef": "prod_R3xK9mN7pQ",
  "name": "Pro",
  "description": "Best for growing teams that need advanced features.",
  "features": [
    {
      "description": "Unlimited projects",
      "type": "INCLUDE"
    },
    {
      "description": "Priority support",
      "type": "INCLUDE"
    },
    {
      "description": "Custom branding",
      "type": "NOT_INCLUDE"
    }
  ],
  "intervals": [
    {
      "id": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
      "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
      "interval": "MONTHLY",
      "amount": 29.99,
      "currency": "USD",
      "status": "ACTIVE",
      "externalRef": "price_1PqR2sT4uV",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    {
      "id": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e5b",
      "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
      "interval": "YEARLY",
      "amount": 299.99,
      "currency": "USD",
      "status": "ACTIVE",
      "externalRef": "price_2WxY3zA5bC",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "highlight": true,
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}