Referência de permissões

Os Stripe Apps usam um sistema de permissões para controlar o acesso aos recursos da API do Stripe. Cada permissão precisa ser declarada explicitamente no manifesto do seu app, com uma finalidade clara. Os usuários aprovam essas permissões quando instalam o app.

Gerenciamento de permissões

Declaração de permissões

Adicione as permissões ao seu manifesto stripe-app.json:

{
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Read customer profiles to sync with Brevo contacts"
    },
    {
      "permission": "customer_write",
      "purpose": "Update customer metadata with Brevo sync status"
    }
  ]
}

Concessão de permissões pela CLI

Durante o desenvolvimento, você pode conceder permissões usando a Stripe CLI:

# Grant a specific permission
stripe apps grant permission "customer_read" \
  --purpose "Read customer profiles to sync with Brevo contacts"

# Grant multiple permissions
stripe apps grant permission "charge_read" \
  --purpose "Access payment data for event tracking"

stripe apps grant permission "event_read" \
  --purpose "Subscribe to real-time Stripe events"

Boas práticas de permissões

• Mínimo necessário: solicite apenas as permissões que o seu app realmente usa
• Finalidades claras: escreva finalidades que usuários sem perfil técnico consigam entender
• Justifique leitura e escrita: se você precisa de leitura e de escrita, explique o motivo em cada finalidade
• Revise com frequência: remova as permissões que deixaram de ser necessárias ao atualizar o seu app

Permissões por produto

Core

Payments

Billing

Checkout

Connect

Issuing

Reporting

Tax

Terminal

Secret Store

Permissões recomendadas para a integração Tajo com a Brevo

Para o app de integração da Tajo com a Brevo, estas são as permissões recomendadas:

{
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Sync customer profiles and contact information to Brevo"
    },
    {
      "permission": "customer_write",
      "purpose": "Store Brevo contact ID and sync status on customer metadata"
    },
    {
      "permission": "charge_read",
      "purpose": "Track purchase events and revenue data for Brevo analytics"
    },
    {
      "permission": "product_read",
      "purpose": "Sync product catalog to Brevo for personalized email campaigns"
    },
    {
      "permission": "event_read",
      "purpose": "Listen to real-time events to trigger Brevo automation workflows"
    },
    {
      "permission": "invoice_read",
      "purpose": "Track invoice events for transactional emails via Brevo"
    },
    {
      "permission": "subscription_read",
      "purpose": "Monitor subscription lifecycle for Brevo retention campaigns"
    },
    {
      "permission": "secret_write",
      "purpose": "Securely store Brevo API credentials in Stripe Secret Store"
    },
    {
      "permission": "secret_read",
      "purpose": "Retrieve stored Brevo API credentials for data sync operations"
    },
    {
      "permission": "webhook_endpoint_write",
      "purpose": "Register webhook endpoints for real-time event delivery to Tajo"
    }
  ]
}

Escopos de permissão

As permissões podem operar em escopos diferentes, dependendo de o seu app estar instalado em uma conta de plataforma ou em uma conta conectada: