> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Assinaturas

> Eventos disparados para assinaturas (PIX e Cartão).

<Tabs>
  <Tab title="subscription.trial_started">
    Disparado quando uma assinatura com período de teste gratuito é criada. O cliente não é cobrado neste momento — a primeira cobrança pelo valor integral ocorre ao final do `trialDays`.

    ```json theme={null}
    {
      "id": "log_trialXYZ123abc",
      "event": "subscription.trial_started",
      "apiVersion": 2,
      "devMode": false,
      "data": {
        "subscription": {
          "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
          "amount": 4990,
          "currency": "BRL",
          "method": "CARD",
          "status": "ACTIVE",
          "frequency": "MONTHLY",
          "trialDays": 7,
          "trialEndsAt": "2024-11-11T23:59:59.999Z",
          "createdAt": "2024-11-04T18:38:28.573Z",
          "updatedAt": "2024-11-04T18:38:28.573Z",
          "canceledAt": null,
          "cancelPolicy": null,
          "cancelledDueTo": null
        },
        "customer": {
          "id": "cust_def456",
          "name": "Maria Santos",
          "email": "maria@exemplo.com",
          "taxId": "12.***.***/0001-**"
        }
      }
    }
    ```
  </Tab>

  <Tab title="subscription.completed">
    Disparado quando uma assinatura se torna ativa.

    <Tabs>
      <Tab title="Cartão">
        ```json theme={null}
        {
          "id": "log_taQArRTApemxwcbw5EJeF3hS",
          "event": "subscription.completed",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "CARD",
              "status": "ACTIVE",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z",
              "canceledAt": null,
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "status": "PAID",
              "methods": ["CARD"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "CARD",
              "CARD": {
                "number": "1234",
                "brand": "VISA"
              }
            },
            "checkout": {
              "id": "bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["CARD"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T19:59:57.819Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>

      <Tab title="PIX">
        ```json theme={null}
        {
          "id": "log_taQArRTApemxwcbw5EJeF3hS",
          "event": "subscription.completed",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "PIX",
              "status": "ACTIVE",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z",
              "canceledAt": null,
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "status": "PAID",
              "methods": ["PIX"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "PIX",
              "PIX": {
                "name": "Maria Santos",
                "taxId": "12.***.***/0001-**",
                "isSameAsCustomer": true
              }
            },
            "checkout": {
              "id": "bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["PIX"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T19:59:57.819Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="subscription.renewed">
    Disparado sempre que uma assinatura é renovada com sucesso.

    <Tabs>
      <Tab title="Cartão">
        ```json theme={null}
        {
          "id": "log_abc123xyz",
          "event": "subscription.renewed",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "CARD",
              "status": "ACTIVE",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2025-01-06T20:00:05.000Z",
              "canceledAt": null,
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "status": "PAID",
              "methods": ["CARD"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2025-01-06T20:00:00.000Z",
              "updatedAt": "2025-01-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "CARD",
              "CARD": {
                "number": "1234",
                "brand": "VISA"
              }
            },
            "checkout": {
              "id": "bill_renewxyz789",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_renewxyz789",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["CARD"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2025-01-06T19:59:57.819Z",
              "updatedAt": "2025-01-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>

      <Tab title="PIX">
        ```json theme={null}
        {
          "id": "log_abc123xyz",
          "event": "subscription.renewed",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "PIX",
              "status": "ACTIVE",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2025-01-06T20:00:05.000Z",
              "canceledAt": null,
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "status": "PAID",
              "methods": ["PIX"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2025-01-06T20:00:00.000Z",
              "updatedAt": "2025-01-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "PIX",
              "PIX": {
                "name": "Maria Santos",
                "taxId": "12.***.***/0001-**",
                "isSameAsCustomer": true
              }
            },
            "checkout": {
              "id": "bill_renewxyz789",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_renewxyz789",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["PIX"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2025-01-06T19:59:57.819Z",
              "updatedAt": "2025-01-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="subscription.cancelled">
    Disparado quando uma assinatura é cancelada.

    <Tabs>
      <Tab title="Cartão">
        ```json theme={null}
        {
          "id": "log_abc123xyz",
          "event": "subscription.cancelled",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "CARD",
              "status": "CANCELLED",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z",
              "canceledAt": "2024-12-06T20:00:05.000Z",
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "status": "PAID",
              "methods": ["CARD"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "CARD",
              "CARD": {
                "number": "1234",
                "brand": "VISA"
              }
            },
            "checkout": {
              "id": "bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 100,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["CARD"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T19:59:57.819Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>

      <Tab title="PIX">
        ```json theme={null}
        {
          "id": "log_abc123xyz",
          "event": "subscription.cancelled",
          "apiVersion": 2,
          "devMode": false,
          "data": {
            "subscription": {
              "id": "subs_tAFqDWBhcEYTjQh2K0ZYDHau",
              "amount": 2990,
              "currency": "BRL",
              "method": "PIX",
              "status": "CANCELLED",
              "frequency": "MONTHLY",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z",
              "canceledAt": "2024-12-06T20:00:05.000Z",
              "cancelPolicy": null,
              "cancelledDueTo": null
            },
            "customer": {
              "id": "cust_def456",
              "name": "Maria Santos",
              "email": "maria@exemplo.com",
              "taxId": "12.***.***/0001-**"
            },
            "payment": {
              "id": "char_xyz789",
              "externalId": "pedido-456",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "status": "PAID",
              "methods": ["PIX"],
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T20:00:00.000Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            },
            "payerInformation": {
              "method": "PIX",
              "PIX": {
                "name": "Maria Santos",
                "taxId": "12.***.***/0001-**",
                "isSameAsCustomer": true
              }
            },
            "checkout": {
              "id": "bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "externalId": null,
              "url": "https://app.abacatepay.com/pay/bill_jskd3TMfScHZDJe5NSZjTmQ4",
              "amount": 2990,
              "paidAmount": 2990,
              "platformFee": 60,
              "frequency": "SUBSCRIPTION",
              "items": [{ "id": "prod_bx4BstRWhQ2SUcKsPt4c6pmq", "quantity": 1 }],
              "status": "PAID",
              "methods": ["PIX"],
              "customerId": "cust_def456",
              "receiptUrl": "https://app.abacatepay.com/receipt/...",
              "createdAt": "2024-12-06T19:59:57.819Z",
              "updatedAt": "2024-12-06T20:00:05.000Z"
            }
          }
        }
        ```
      </Tab>
    </Tabs>
  </Tab>
</Tabs>
