generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 9
Add Usage and billing #405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
33b6709
Add credits and spend limits
manototh 9e8734f
Add all procedures
manototh 19a4e04
Update usage-billing.mdx
manototh 4146472
Update usage-billing.mdx
manototh 7500ead
Add more info to spending limit
manototh be90edf
Fix what's included in spending limit
manototh 4ece8fe
Implement review
manototh 3024a3c
Merge branch 'main' into mano/spend-limits
manototh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
--- | ||
title: 'Usage and billing' | ||
description: 'This section explains how to manage usage and billing within your Axiom organization.' | ||
--- | ||
|
||
## Billing | ||
|
||
To view details about your next and last bill, go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Billing**. | ||
|
||
The Current breakdown section explains what you paid for in your last bill and what you can expect to pay for in your next will. | ||
|
||
### View billing history | ||
|
||
To view details about your billing history: | ||
|
||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Billing**. | ||
1. In the Current breakdown section, click **Billing history**. | ||
|
||
### Compute credits | ||
|
||
You can save on compute spending by pre-purchasing compute credits. This means that you purchase credits in advance at a discount. The more credits you purchase, the higher the discount rate. For more information, see [Pricing](https://axiom.co/pricing). | ||
|
||
Your compute credits can cover the following costs: | ||
- Data loading | ||
- Query compute | ||
|
||
Your compute credits can’t cover the following costs: | ||
- Your pricing plan | ||
- Add-ons | ||
- Storage | ||
|
||
To purchase compute credits: | ||
|
||
1. Ensure you have permissions to modify billing. For more information, see [Role-Based Access Control](/reference/settings). | ||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Billing**. | ||
1. In the Compute credits section, click **Add credits**. | ||
1. Enter the amount of credits you want to purchase. | ||
1. Review the total cost. | ||
1. Click **Buy credits**. | ||
1. Complete the purchase. | ||
|
||
### Spending limit | ||
|
||
Setting a monthly spending limit allows you to control costs. | ||
|
||
<Warning> | ||
The spending limit takes into account the costs you’re billed for at the end of your billing period. If your organization reaches the spend limit in a billing period, Axiom immediately prevents actions that generate further costs. For example, if you have used up the allowances included in your pricing plan, you can’t run queries or ingest more data, and your monitors can’t query your data. This can cause interruptions to your service. | ||
</Warning> | ||
|
||
Even if you reach your spending limit, you can still initiate purchases manually such as buying add-ons and credits. | ||
|
||
To set a monthly spending limit: | ||
|
||
1. Ensure you have permissions to modify billing. For more information, see [Role-Based Access Control](/reference/settings). | ||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Billing**. | ||
1. In the Limit section, click **Manage limit**. | ||
1. Turn on **Set monthly spending limit**. | ||
1. Enter the maximum monthly spending. | ||
1. Click **Save changes**. | ||
|
||
<Info> | ||
If your organization reaches the spend limit, Axiom sends an email to the owner of your organization. To avoid further interruptions to your service, increase the spend limit. Your service resumes until usage-related costs reach the amount by which you increased the limit. The spend limit resets in the next billable period as usual. | ||
</Info> | ||
|
||
## Pricing plan | ||
|
||
### View plan details | ||
|
||
To view details about your current plan: | ||
|
||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Plan**. | ||
1. Click **License**. | ||
|
||
This page gives you an overview of the allowances included in your plan and your current monthly usage. | ||
|
||
### Upgrade or downgrade plan | ||
|
||
To upgrade or downgrade your plan: | ||
|
||
1. Ensure you have permissions to modify billing. For more information, see [Role-Based Access Control](/reference/settings). | ||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Plan**. | ||
1. Click <img src="/doc-assets/icons/ellipsis-vertical.svg" className="inline-icon" alt="Vertical ellipsis icon" /> **More > Upgrade** or <img src="/doc-assets/icons/ellipsis-vertical.svg" className="inline-icon" alt="Vertical ellipsis icon" /> **More > Downgrade**. | ||
|
||
### Manage add-ons | ||
|
||
You can manage the following add-ons: | ||
|
||
- Additional regions | ||
- Audit log | ||
- Directory Sync | ||
- Role-Based Access Control (RBAC) | ||
- SAML SSO | ||
|
||
To manage add-ons: | ||
|
||
1. Ensure you have permissions to modify billing. For more information, see [Role-Based Access Control](/reference/settings). | ||
1. Go to <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Plan**. | ||
1. Click the add-on area. | ||
1. Select or deselect add-ons. | ||
1. Review the updated base monthly cost. | ||
1. Click **Update add-ons**. | ||
|
||
## Usage | ||
|
||
To view details about your organization’s total usage of Axiom: | ||
|
||
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Usage**. | ||
1. To select the period for which you want to display usage, click <img src="/doc-assets/icons/clock.svg" className="inline-icon" alt="Time range" /> **Time range**. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.