Subscription Integration Guide

​

Prerequisites

• A Dodo Payments merchant account
• API credentials (API key and webhook secret key) from the dashboard

​

API Integration

​

Checkout Sessions

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode', // defaults to 'live_mode'
});

async function main() {
  const session = await client.checkoutSessions.create({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    // Optional: configure trials for subscription products
    subscription_data: { trial_period_days: 14 },
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe',
    },
    return_url: 'https://example.com/success',
  });

  console.log(session.checkout_url);
}

main();

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",  # defaults to "live_mode"
)

session = client.checkout_sessions.create(
    product_cart=[
        {"product_id": "prod_subscription_monthly", "quantity": 1}
    ],
    subscription_data={"trial_period_days": 14},  # optional
    customer={
        "email": "subscriber@example.com",
        "name": "Jane Doe",
    },
    return_url="https://example.com/success",
)

print(session.checkout_url)

const response = await fetch('https://test.dodopayments.com/checkouts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.DODO_PAYMENTS_API_KEY}`
  },
  body: JSON.stringify({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    subscription_data: { trial_period_days: 14 }, // optional
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe'
    },
    return_url: 'https://example.com/success'
  })
});

if (!response.ok) {
  throw new Error(`HTTP error! status: ${response.status}`);
}

const session = await response.json();
console.log(session.checkout_url);

​

API Response

{
  "session_id": "cks_Gi6KGJ2zFJo9rq9Ukifwa",
  "checkout_url": "https://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"
}

​

Webhooks

​

Tipos de Eventos de Assinatura

1. subscription.active - Assinatura ativada com sucesso.
2. subscription.updated - Objeto de assinatura foi atualizado (acionado em qualquer alteração de campo).
3. subscription.on_hold - Assinatura suspensa devido a falha na renovação.
4. subscription.failed - Falha na criação da assinatura durante a criação do mandato.
5. subscription.renewed - Assinatura renovada para o próximo período de cobrança.

​

Cenários de Pagamento

1. subscription.active: o mandato é autorizado e a assinatura é ativada.
2. payment.succeeded: confirma a primeira cobrança. Espere recebê-lo em 2 a 10 minutos após o checkout.

1. No início do teste (checkout): subscription.active é disparado assim que o método de pagamento é autorizado. Nenhuma cobrança recorrente é realizada ainda. A primeira cobrança real é adiada até o término do teste.
2. No término do teste: o valor recorrente é cobrado, e você recebe payment.succeeded junto com subscription.renewed.

• subscription.renewed: é disparado em cada ciclo de cobrança quando o pagamento da renovação é debitado, sempre junto com payment.succeeded. Ele também inclui o next_billing_date atualizado.

1. Falha na assinatura

• subscription.failed - A criação da assinatura falhou porque não foi possível criar um mandato.
• payment.failed - Indica um pagamento malsucedido.

2. Assinatura suspensa

• subscription.on_hold - A assinatura é suspensa devido a uma falha no pagamento da renovação ou na cobrança da alteração do plano.
• Quando uma assinatura é suspensa, ela não será renovada automaticamente até que o método de pagamento seja atualizado.

​

subscription.failed vs. subscription.on_hold

​

Como lidar com uma assinatura suspensa

​

Quando as assinaturas são suspensas

• O pagamento da renovação falha: a cobrança automática da renovação falha devido a fundos insuficientes, cartão expirado ou recusa do banco
• A cobrança da alteração do plano falha: uma cobrança imediata durante o upgrade ou downgrade do plano falha
• A autorização do método de pagamento falha: não é possível autorizar o método de pagamento para cobranças recorrentes

​

Reativando assinaturas suspensas

1. Cria uma cobrança pelos valores pendentes
2. Gera uma fatura para a cobrança
3. Processa o pagamento usando o novo método de pagamento
4. Reativa a assinatura para o estado active após o pagamento bem-sucedido

// Webhook handler
app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;
  
  if (event.type === 'subscription.on_hold') {
    const subscription = event.data;
    
    // Update subscription status in your database
    await updateSubscriptionStatus(subscription.subscription_id, 'on_hold');
    
    // Notify customer to update payment method
    await sendEmailToCustomer(subscription.customer_id, {
      subject: 'Payment Required - Subscription On Hold',
      message: 'Your subscription is on hold. Please update your payment method to continue service.'
    });
  }
  
  res.json({ received: true });
});

// Update with new payment method
const response = await client.subscriptions.updatePaymentMethod(subscriptionId, {
  type: 'new',
  return_url: 'https://example.com/return'
});

// For on_hold subscriptions, a charge is automatically created
if (response.payment_id) {
  console.log('Charge created for remaining dues:', response.payment_id);
  // Redirect customer to response.payment_link to complete payment
}

# Update with new payment method
response = client.subscriptions.update_payment_method(
    subscription_id=subscription_id,
    type="new",
    return_url="https://example.com/return"
)

# For on_hold subscriptions, a charge is automatically created
if response.payment_id:
    print("Charge created for remaining dues:", response.payment_id)
    # Redirect customer to response.payment_link to complete payment

await client.subscriptions.updatePaymentMethod(subscriptionId, {
  type: 'existing',
  payment_method_id: 'pm_abc123'
});

if (event.type === 'payment.succeeded') {
  const payment = event.data;
  
  // Check if this payment is for an on_hold subscription
  if (payment.subscription_id) {
    // Wait for subscription.active webhook to confirm reactivation
  }
}

if (event.type === 'subscription.active') {
  const subscription = event.data;
  
  // Update subscription status in your database
  await updateSubscriptionStatus(subscription.subscription_id, 'active');
  
  // Restore customer access
  await restoreCustomerAccess(subscription.customer_id);
  
  // Notify customer of successful reactivation
  await sendEmailToCustomer(subscription.customer_id, {
    subject: 'Subscription Reactivated',
    message: 'Your subscription has been reactivated successfully.'
  });
}

​

Exemplo de payload de evento de assinatura

​

Alterando planos de assinatura

​

Opções de rateio proporcional

​

1. prorated_immediately

• Calcula o valor proporcional com base no tempo restante do ciclo de cobrança atual
• Cobra do cliente apenas a diferença entre o plano antigo e o novo
• Durante um período de teste, isso muda imediatamente o usuário para o novo plano, cobrando o cliente na hora

​

2. full_immediately

• Cobra do cliente o valor integral da assinatura do novo plano
• Ignora qualquer tempo ou crédito restante do plano anterior
• Útil quando você deseja redefinir o ciclo de cobrança ou cobrar o valor integral independentemente do rateio proporcional

​

3. difference_immediately

• Ao fazer upgrade, o cliente é cobrado imediatamente pela diferença entre os valores dos dois planos.
• Por exemplo, se o plano atual custa 30 dólares e o cliente fizer upgrade para um plano de 80 dólares, serão cobrados $50 instantaneamente.
• Ao fazer downgrade, o valor não utilizado do plano atual é adicionado como crédito interno e aplicado automaticamente às futuras renovações da assinatura.
• Por exemplo, se o plano atual custa 50 dólares e o cliente mudar para um plano de 20 dólares, os $30 restantes serão creditados e usados no próximo ciclo de cobrança.

​

4. do_not_bill

• Aplica a alteração do plano imediatamente, mas não cobra nada no momento da alteração.
• O plano atualizado (e a quantidade/add-ons) será cobrado na próxima renovação programada, e a data de cobrança original será preservada.

​

Comportamento

• Quando você chama esta API, Dodo Payments inicia imediatamente uma cobrança com base na opção de rateio proporcional selecionada
• Se a alteração do plano for um downgrade e você usar prorated_immediately, os créditos serão calculados e adicionados automaticamente ao saldo de créditos da assinatura. Esses créditos são específicos dessa assinatura e serão usados somente para compensar pagamentos recorrentes futuros da mesma assinatura
• A opção full_immediately ignora os cálculos de crédito e cobra o valor integral do novo plano

​

Processamento da cobrança

• A cobrança imediata iniciada após a alteração do plano geralmente termina de ser processada em menos de 2 minutos
• Se essa cobrança imediata falhar por qualquer motivo, a assinatura será automaticamente suspensa até que o problema seja resolvido

​

Assinaturas sob demanda

​

Principais informações sobre a cobrança de assinaturas

​

Referência de API relacionada