diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index d8eb676d5b1..8a15ec3083f 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -2167,6 +2167,10 @@ export const platform: NavMenuConstant = { name: 'Monthly Active Third-Party Users', url: '/guides/platform/manage-your-usage/monthly-active-users-third-party', }, + { + name: 'Realtime Messages', + url: '/guides/platform/manage-your-usage/realtime-messages', + }, ], }, { diff --git a/apps/docs/content/guides/platform/manage-your-usage.mdx b/apps/docs/content/guides/platform/manage-your-usage.mdx index 68a76fe175d..3bd610a08bd 100644 --- a/apps/docs/content/guides/platform/manage-your-usage.mdx +++ b/apps/docs/content/guides/platform/manage-your-usage.mdx @@ -20,4 +20,5 @@ Each subpage breaks down a specific usage item and details what you're charged f - [Point-in-Time Recovery](/docs/guides/platform/manage-your-usage/point-in-time-recovery) - [Monthly Active Users](/docs/guides/platform/manage-your-usage/monthly-active-users) - [Monthly Active SSO Users](/docs/guides/platform/manage-your-usage/monthly-active-users-sso) -- [Monthly Active Third-Party Users](/docs/guides/platform/manage-your-usage/monthly-active-users-third-party) \ No newline at end of file +- [Monthly Active Third-Party Users](/docs/guides/platform/manage-your-usage/monthly-active-users-third-party) +- [Realtime Messages](/docs/guides/platform/manage-your-usage/realtime-messages) \ No newline at end of file diff --git a/apps/docs/content/guides/platform/manage-your-usage/realtime-messages.mdx b/apps/docs/content/guides/platform/manage-your-usage/realtime-messages.mdx new file mode 100644 index 00000000000..cb1f4bcd7d6 --- /dev/null +++ b/apps/docs/content/guides/platform/manage-your-usage/realtime-messages.mdx @@ -0,0 +1,84 @@ +--- +id: 'manage-usage-realtime-messages' +title: 'Manage Realtime Messages usage' +--- + +## What you are charged for +You are charged for the number of messages going through Supabase Realtime throughout the billing cycle. Includes database changes, Broadcast and Presence. + +**Database changes** +Each database change counts as one message per client that listens to the event. For example, if a database change occurs and 5 clients listen to that database event, it counts as 5 messages. + +**Broadcast** +Each broadcast message counts as one message sent plus one message per subscribed client that receives it. For example, if you broadcast a message and 4 clients listen to it, it counts as 5 messages—1 sent and 4 received. + +## How charges are calculated +Realtime Messages are billed using Package pricing, with each package representing 1 million messages. If your usage falls between two packages, you are billed for the next whole package. + +### Example +For simplicity, let's assume a package size of 5 and a charge of $2 per package. + +| Number Of Messages | Number Of Packages Billed | Costs | +|--------------------|---------------------------|-------| +| 4 | 1 | $2 | +| 5 | 1 | $2 | +| 6 | 2 | $4 | + +### Usage on your invoice +Usage is shown as "Realtime Messages" on your invoice. + +## Pricing +$2.50 per 1 million messages. You are only charged for usage exceeding your subscription plan's quota. + +| Plan | Quota | Over-Usage | +|------------|--------------------|---------------------| +| Free | 2 Million messages | - | +| Pro | 5 Million messages | $2.50 per 1 Million | +| Team | 5 Million messages | $2.50 per 1 Million | +| Enterprise | Custom | Custom | + +## Billing examples +### Within quota +The organization's Realtime messages are within the quota, so no charges apply. + +| Line Item | Units | Costs | +|---------------------|----------------------|---------| +| Pro Plan | 1 | $25 | +| Compute Hours Micro | 744 hours | $10 | +| Realtime Messages | 1.8 million messages | $0 | +| **Subtotal** | | **$35** | +| Compute Credits | | -$10 | +| **Total** | | **$25** | + +### Exceeding quota +The organization's Realtime messages exceed the quota by 3.5 million, incurring charges for this additional usage. + +| Line Item | Units | Costs | +|---------------------|----------------------|---------| +| Pro Plan | 1 | $25 | +| Compute Hours Micro | 744 hours | $10 | +| Realtime Messages | 8.5 million messages | $10 | +| **Subtotal** | | **$45** | +| Compute Credits | | -$10 | +| **Total** | | **$35** | + +## View usage +You can view Realtime Messages usage on the [organization's usage page](https://supabase.com/dashboard/org/_/usage). The page shows the usage of all projects by default. To view the usage for a specific project, select it from the dropdown. You can also select a different time period. +Usage page navigation bar + +In the Realtime Messages section, you can see the usage for the selected time period. +Usage page Realtime Messages section \ No newline at end of file diff --git a/apps/docs/public/img/guides/platform/usage-realtime-messages--dark.png b/apps/docs/public/img/guides/platform/usage-realtime-messages--dark.png new file mode 100644 index 00000000000..15cff06fbc0 Binary files /dev/null and b/apps/docs/public/img/guides/platform/usage-realtime-messages--dark.png differ diff --git a/apps/docs/public/img/guides/platform/usage-realtime-messages--light.png b/apps/docs/public/img/guides/platform/usage-realtime-messages--light.png new file mode 100644 index 00000000000..4e6b199f492 Binary files /dev/null and b/apps/docs/public/img/guides/platform/usage-realtime-messages--light.png differ