Introduction

​

O que são Entitlements?

​

Available Integrations

​

How Grants Work

​

Grant Lifecycle

​

Comportamento dos Grants por Evento

​

Crie seu primeiro entitlement

1

Open Entitlements

Acesse Entitlements no dashboard e clique em + para criar um entitlement.

2

Pick an Integration

Escolha o tipo de integração: License Key, Digital Files, Feature Flag, Discord, GitHub, Telegram, Figma, Framer ou Notion. Para uma integração de plataforma, conecte sua conta primeiro, caso ainda não tenha feito isso.

3

Configure Delivery

Preencha os campos da integração. Por exemplo, o GitHub solicita um repositório e um nível de permissão, o Discord solicita um servidor e uma função opcional, e License Key solicita um limite de ativações e uma duração da licença.

4

Save

Clique em Create Entitlement. Agora você pode associar o entitlement a qualquer produto.

​

Associe Entitlements a Produtos

​

Experiência do Cliente

​

E-mail e Customer Portal

​

Entrega baseada em OAuth

​

Revogação

​

Gerenciar Grants

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'],
});

// List grants for an entitlement
const grants = await client.entitlements.grants.list('ent_abc123', {
  status: 'Delivered',
});

// Revoke a single grant
await client.entitlements.grants.revoke('entg_xyz789', {
  id: 'ent_abc123',
});

# Assumes client = DodoPayments(bearer_token=os.environ["DODO_PAYMENTS_API_KEY"])
grants = client.entitlements.grants.list(
    "ent_abc123",
    status="Delivered",
)

client.entitlements.grants.revoke(
    "entg_xyz789",
    id="ent_abc123",
)

// Assumes client := dodopayments.NewClient() and ctx := context.Background().
grants, err := client.Entitlements.Grants.List(
  ctx, "ent_abc123",
  dodopayments.EntitlementGrantListParams{
    Status: dodopayments.F(dodopayments.EntitlementGrantListParamsStatusDelivered),
  },
)
if err != nil {
  panic(err.Error())
}
fmt.Println(len(grants.Items))

_, err = client.Entitlements.Grants.Revoke(ctx, "ent_abc123", "entg_xyz789")

​

Gerenciamento pela API

​

Webhooks

​

Boas práticas

• Use um entitlement por canal de entrega. Não compartilhe um entitlement do Discord entre produtos com intenções de função diferentes. Crie um entitlement por função para que a revogação permaneça limpa.
• Faça testes primeiro no modo de teste. Crie o entitlement, associe-o a um produto de teste, execute um checkout e observe o grant passar de Pending para Delivered. Depois, cancele a assinatura de teste e confirme que o grant foi revogado.
• Escute entitlement_grant.delivered, não payment.succeeded. Um pagamento pode ser bem-sucedido antes que o fulfillment seja concluído, especialmente em fluxos OAuth. Aguarde o grant chegar a Delivered antes de desbloquear funcionalidades dependentes em seus próprios sistemas. Um grant entregue na criação, como uma chave de licença preenchida automaticamente ou uma feature flag, chega como entitlement_grant.created com status: "Delivered".
• Trate entitlement_grant.failed como acionável. Um grant com falha significa que um cliente pagou, mas não obteve acesso. Apresente esses grants à sua equipe de suporte ou acione uma nova emissão.
• Mapeie revocation_reason para seus fluxos de retenção. Uma revogação subscription_on_hold pode ser recuperada, pois o cliente pode atualizar o cartão. Uma revogação manual é intencional. Trate-as de forma diferente nas mensagens aos clientes.
• Não revogue o acesso em subscription.past_due. Esse evento inicia um período de carência, e o cliente mantém o acesso até o fim da janela. Aguarde subscription.on_hold ou subscription.cancelled.