---
title: "When time-relative reminders fire"
description: "Lead times in days for trial_ending, renewal_reminder, cancellation_reminder, payment_due_reminder, pause_reminder, resume_reminder, card_expiring and pre_debit_notification, for this…"
canonical_url: "https://twominutebilling.com/help/developers/api-reference/webhooks/when-time-relative-reminders-fire"
---
# When time-relative reminders fire

> Lead times in days for trial_ending, renewal_reminder, cancellation_reminder, payment_due_reminder, pause_reminder, resume_reminder, card_expiring and pre_debit_notification, for this…

<api-operation method="GET" path="/v1/businesses/{biz}/emails/reminders">
<template v-slot:docs="">

Lead times in days for `trial_ending`, `renewal_reminder`, `cancellation_reminder`, `payment_due_reminder`, `pause_reminder`, `resume_reminder`, `card_expiring` and `pre_debit_notification`, for this business. The first three come from the business's `reminder_config` (each row's `configurable` is true); the pre-debit notice is fixed and a MINIMUM rather than a target: NPCI/RBI require the payer be told at least 24h before a mandate debit, so its window carries margin for a delayed tick.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        email_reminder_schedule
      </code>
      
      . One of <code>
        email_reminder_schedule
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        configurable
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Whether the reminder schedule can be changed.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The reminder emails and when they go out.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.type
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The reminder's email type.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.days_before
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      The largest lead day: the first reminder. Null when the reminder is off.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.expiry_month
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      card_expiring only: true when the notice goes out in the card's expiry month instead of on lead days.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.lead_days
      </code>
    </td>
    
    <td>
      <code>
        array of integer
      </code>
    </td>
    
    <td>
      Every lead day, largest first.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.yearly_days_before
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      renewal_reminder only: the largest lead day on yearly plans.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.yearly_lead_days
      </code>
    </td>
    
    <td>
      <code>
        array of integer
      </code>
    </td>
    
    <td>
      renewal_reminder only: every lead day on yearly plans.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.configurable
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Whether <code>
        reminder_config
      </code>
      
       on the business sets this row. False for the pre-debit notice.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such business
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/emails/reminders" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "email_reminder_schedule",
  "configurable": false,
  "data": [
    {
      "type": "Type",
      "days_before": 1,
      "expiry_month": false,
      "lead_days": [
        14
      ],
      "yearly_days_before": 2026,
      "yearly_lead_days": [
        14
      ]
    }
  ]
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such business"
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.