From 2ae4562871eb9cbf88b5339ae0cc032355bbf56d Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Wed, 8 Mar 2023 12:10:10 +0800 Subject: [PATCH 1/3] init spend cap guide --- .../NavigationMenu.constants.ts | 5 ++ apps/docs/pages/guides/platform/spend-cap.mdx | 56 +++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 apps/docs/pages/guides/platform/spend-cap.mdx diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index f367d6aad97..5587a1c2748 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -674,6 +674,11 @@ export const platform = { { name: 'SSL Enforcement', url: '/guides/platform/ssl-enforcement', items: [] }, ], }, + { + name: 'Billing Management', + url: undefined, + items: [{ name: 'Spend cap', url: '/guides/platform/spend-cap', items: [] }], + }, { name: 'Single sign-on', url: undefined, diff --git a/apps/docs/pages/guides/platform/spend-cap.mdx b/apps/docs/pages/guides/platform/spend-cap.mdx new file mode 100644 index 00000000000..71e64e11beb --- /dev/null +++ b/apps/docs/pages/guides/platform/spend-cap.mdx @@ -0,0 +1,56 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + title: 'Spend cap', + description: 'Learn about the cost control of Supabase.', +} + +For managing cost control for each project, there is a Spend Cap to manage your usage and costs. + +Each project's Spend Cap determines wether your project can exceed the free quota allowance of any paid [line item](#what-can-i-be-charged-for) in a given billing cycle. +If you exceed the free quota allowance of a line item, and the Spend Cap is **"off"**, then you will be billed for any additional usage on that line item. + +## What additional usage can I be charged for? + +Supabase charges for certain usage line items in your project. Those line items include: + +- Database Size +- Storage Size +- Egress +- Asset transformations +- Realtime connections +- Realtime concurrent peak connections +- Realtime messages +- Edge function invocations +- Number of Edge functions + +You can view the pricing, and free quota allowance of each line item on the [pricing page](/pricing). + +You can monitor your usage and costs using the [Usage section of your project](https://app.supabase.com/project/_/settings/billing/usage) in the dashboard. +This will show you how much you have spent so far in the current billing cycle, as well as an estimate of your expected total cost for the cycle based on your current usage. + +## How can I turn the Spend Cap on or off? + +To set up a Spend Cap in your project, navigate to the [Subscription section](https://app.supabase.com/project/_/settings/billing/subscription) of your project. +From there, you can click on "Change subscription" to select the plan you want to use and, at the same time, turn on or off the Spend Cap. + +## What happens when the Spend Cap is on + +Once you use all your free quota allowance for a [line item](#what-can-i-be-charged-for), your project will not allow any further usage on that line item until the next billing cycle begins. + +This can help you to avoid unexpected costs and manage your expenses more effectively. + +## What happens when Spend Cap is off? + +Once you use all the free quota allowance for a [line item](#what-can-i-be-charged-for), your project will continually be able to make further usage. +This additional usage will be charged based on the line item's cost per unit outlined on the [pricing page](/pricing). + + + It is advised, when your Spend Cap is **off**, to monitor your usage and costs using the [Usage + section of your project](https://app.supabase.com/project/_/settings/billing/usage) in the + dashboard. + + +export const Page = ({ children }) => + +export default Page From 234646256eca1db7267defd4d53336ce6d9b8826 Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Wed, 8 Mar 2023 17:00:25 +0800 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com> --- apps/docs/pages/guides/platform/spend-cap.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/apps/docs/pages/guides/platform/spend-cap.mdx b/apps/docs/pages/guides/platform/spend-cap.mdx index 71e64e11beb..fefcf98e75b 100644 --- a/apps/docs/pages/guides/platform/spend-cap.mdx +++ b/apps/docs/pages/guides/platform/spend-cap.mdx @@ -5,9 +5,9 @@ export const meta = { description: 'Learn about the cost control of Supabase.', } -For managing cost control for each project, there is a Spend Cap to manage your usage and costs. +Supabase offers a "Spend Cap" on each project to manage your usage and costs. -Each project's Spend Cap determines wether your project can exceed the free quota allowance of any paid [line item](#what-can-i-be-charged-for) in a given billing cycle. +This Spend Cap determines whether your project can exceed the free quota allowance of any [line item](#what-can-i-be-charged-for) in a given billing cycle. If you exceed the free quota allowance of a line item, and the Spend Cap is **"off"**, then you will be billed for any additional usage on that line item. ## What additional usage can I be charged for? @@ -34,7 +34,7 @@ This will show you how much you have spent so far in the current billing cycle, To set up a Spend Cap in your project, navigate to the [Subscription section](https://app.supabase.com/project/_/settings/billing/subscription) of your project. From there, you can click on "Change subscription" to select the plan you want to use and, at the same time, turn on or off the Spend Cap. -## What happens when the Spend Cap is on +## What happens when the Spend Cap is on? Once you use all your free quota allowance for a [line item](#what-can-i-be-charged-for), your project will not allow any further usage on that line item until the next billing cycle begins. @@ -42,11 +42,11 @@ This can help you to avoid unexpected costs and manage your expenses more effect ## What happens when Spend Cap is off? -Once you use all the free quota allowance for a [line item](#what-can-i-be-charged-for), your project will continually be able to make further usage. +Your project will continue to operate after using all the free quota allowance for each [line item](#what-can-i-be-charged-for). This additional usage will be charged based on the line item's cost per unit outlined on the [pricing page](/pricing). - It is advised, when your Spend Cap is **off**, to monitor your usage and costs using the [Usage + When your Spend Cap is **off**, we recommend monitoring your consumption and costs using the [Usage section of your project](https://app.supabase.com/project/_/settings/billing/usage) in the dashboard. From 3f5d922fdfc50fdf3d5893d93ac4c9c0bfb0000a Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Thu, 9 Mar 2023 12:51:56 +0800 Subject: [PATCH 3/3] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Kevin Grüneberg --- .../Navigation/NavigationMenu/NavigationMenu.constants.ts | 2 +- apps/docs/pages/guides/platform/spend-cap.mdx | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index 5587a1c2748..4eefd9b9ede 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -675,7 +675,7 @@ export const platform = { ], }, { - name: 'Billing Management', + name: 'Billing', url: undefined, items: [{ name: 'Spend cap', url: '/guides/platform/spend-cap', items: [] }], }, diff --git a/apps/docs/pages/guides/platform/spend-cap.mdx b/apps/docs/pages/guides/platform/spend-cap.mdx index fefcf98e75b..f90254db1bb 100644 --- a/apps/docs/pages/guides/platform/spend-cap.mdx +++ b/apps/docs/pages/guides/platform/spend-cap.mdx @@ -18,7 +18,6 @@ Supabase charges for certain usage line items in your project. Those line items - Storage Size - Egress - Asset transformations -- Realtime connections - Realtime concurrent peak connections - Realtime messages - Edge function invocations