Skip to content

Commit 8af1614

Browse files
docs: sync plan limits and feature gating with new Free-tier pricing
1 parent 64a6369 commit 8af1614

4 files changed

Lines changed: 46 additions & 5 deletions

File tree

‎mintlify/docs/cli/overview.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ ub collection delete "users" --force
138138

139139
### `ub status`
140140
Shows your account usage and recent API activity to help you monitor your limits and project health.
141+
Usage is shown against your plan limits (projects, collections, database, storage, API requests, auth users, and webhooks). Limits that are unlimited on your plan display as `Unlimited`.
141142

142143
```bash
143144
ub status

‎mintlify/docs/guides/mail-platform.mdx‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ urBackend Mail Platform extends transactional sending into a full delivery workf
1212
- BYOK (Bring Your Own Key) with encrypted project-level Resend keys
1313
- delivery tracking via persistent `MailLog`
1414
- audience/contact management (BYOK-gated)
15-
- marketing broadcasts (BYOK + Pro gated)
15+
- marketing broadcasts (BYOK-gated, counted against the monthly mail quota)
1616
- webhook-driven status updates with Svix verification
1717

1818
Implementation references:
@@ -46,12 +46,16 @@ flowchart LR
4646

4747
| Capability | Free (shared key) | Free + BYOK | Pro + BYOK |
4848
|---|---:|---:|---:|
49+
| Monthly mail quota | 50 | 50 | 1,000 |
4950
| Transactional send (`/api/mail/send`) | ✅ | ✅ | ✅ |
5051
| Batch send (`/api/mail/send-batch`, max 100 items) | ✅ | ✅ | ✅ |
52+
| Custom mail templates (`templateId` / `templateName`) | ✅ | ✅ | ✅ |
5153
| Delivery logs + live status | ✅ | ✅ | ✅ |
5254
| Audiences & Contacts | ❌ | ✅ | ✅ |
5355
| Marketing Broadcasts | ❌ | ✅ (within 50/mo limit) | ✅ (within 1,000/mo limit) |
5456

57+
BYOK is available on every plan, including Free. Audiences, contacts, and broadcasts only require a configured BYOK Resend key. They do not require a Pro plan.
58+
5559
## Getting started
5660

5761
### Prerequisites
@@ -414,7 +418,7 @@ await client.request('DELETE', '/api/mail/audiences/aud_123/contacts/ct_123');
414418

415419
</CodeGroup>
416420

417-
## Marketing broadcasts (BYOK + Pro)
421+
## Marketing broadcasts (BYOK)
418422

419423
Endpoints:
420424

@@ -437,7 +441,9 @@ Endpoints:
437441

438442
### Quota checks
439443

440-
Broadcast create/send/list/detail/delete paths run behind mail usage gating middleware and plan checks.
444+
Broadcasts require a configured BYOK Resend key on the project. They are available on both the Free and Pro plans.
445+
446+
Each broadcast send reserves one slot from the project's shared monthly mail quota (50 on Free, 1,000 on Pro), the same quota used by transactional sends. If Resend rejects the send, urBackend refunds the reserved slot so failed sends do not count against your quota.
441447

442448
<CodeGroup>
443449

@@ -574,7 +580,8 @@ Route: `/project/:projectId/mail`
574580

575581
- compose audience + subject + html
576582
- send campaign via broadcast API
577-
- locked unless BYOK is configured and account is Pro
583+
- locked if BYOK key is not configured
584+
- each send counts against the monthly mail quota
578585

579586
<Info>
580587
Add product screenshots/annotated walkthrough images in this section if your docs deployment supports hosted image assets.
@@ -635,7 +642,7 @@ Compared to legacy single-send usage:
635642
- `/api/mail/send-batch` adds bulk dispatch (up to 100 items/request)
636643
- `MailLog` is first-class for auditability and dashboard visibility
637644
- new BYOK-gated resources: audiences, contacts
638-
- new BYOK+Pro resource: broadcasts
645+
- new BYOK-gated resource: broadcasts (counted against the monthly mail quota)
639646
- webhook path requires raw-body middleware placement before JSON parser
640647
- new env dependencies for production-grade mail processing (`RESEND_WEBHOOK_SECRET`, sender defaults)
641648

‎mintlify/docs/guides/webhooks.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Webhooks let urBackend notify your server the moment data changes in your collec
1414
3. Either copy the auto-generated signing secret or enter your own. Store this secret securely — you will use it to verify incoming requests.
1515
4. Save the webhook. urBackend will begin sending events to your URL immediately.
1616

17+
<Note>
18+
The Free plan allows up to 3 webhooks per project, including disabled ones. The Pro plan has no webhook limit. The limit only applies when you create a webhook. You can still edit, delete, and test existing webhooks at the limit. See [Limits & Quotas](/limits-and-quotas#webhook-limits).
19+
</Note>
20+
1721
## Payload format
1822

1923
Every webhook event is delivered as a `POST` request with a JSON body in this shape:

‎mintlify/docs/limits-and-quotas.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,35 @@ Files that exceed the limit return `413 Payload Too Large`. Projects connected t
3232

3333
When your project approaches the database quota, writes may be rejected with `403 Forbidden`. Monitor your usage in the Dashboard.
3434

35+
## Mail limits
36+
37+
Mail sent through the Mail Platform counts against a per-project monthly quota. Transactional sends, batch sends, and marketing broadcasts all draw from the same quota.
38+
39+
| Plan | Emails per month |
40+
| :--- | :--- |
41+
| Free | 50 |
42+
| Pro | 1,000 |
43+
44+
Custom mail templates and BYOK (your own Resend key) are available on both plans. See [Mail Platform](/guides/mail-platform).
45+
46+
## Webhook limits
47+
48+
| Plan | Webhooks per project |
49+
| :--- | :--- |
50+
| Free | 3 |
51+
| Pro | Unlimited |
52+
53+
Every webhook in the project counts toward the limit, including disabled ones. Only webhook creation is count-gated. Creating a webhook when the project is already at its limit returns `403 Forbidden` with the message `Webhook limit reached (3). Please upgrade your plan for unlimited webhooks.` Editing, deleting, and testing existing webhooks are not restricted. Automatic delivery retries are available on both plans.
54+
55+
## Team member limits
56+
57+
| Plan | Members per project (including the owner) |
58+
| :--- | :--- |
59+
| Free | 2 |
60+
| Pro | 6 |
61+
62+
Inviting a member beyond the limit returns `403 Forbidden`.
63+
3564
## AI session limits
3665

3766
AI features that use urBackend's platform Groq key are capped per account, per calendar month. The AI Query Builder and the AI Collection Creator (Schema Design) each have their own separate monthly counter.

0 commit comments

Comments
 (0)