Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@
"reference/organization-settings"
]
},
"reference/usage-billing",
"reference/profile"
]
},
Expand Down Expand Up @@ -597,7 +598,7 @@
]
},
{
"group": "Role-based access control endpoints",
"group": "Role-Based Access Control endpoints",
"pages": [
"restapi/endpoints/listRoles",
"restapi/endpoints/getRoleById",
Expand Down
4 changes: 2 additions & 2 deletions getting-started-guide/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,9 @@ For more information, see [Optimize usage](/reference/optimize-usage).

## R

### Role-based access control (RBAC)
### Role-Based Access Control (RBAC)

Role-based access control (RBAC) allows you to manage and restrict access to your data and resources efficiently.
Role-Based Access Control (RBAC) allows you to manage and restrict access to your data and resources efficiently.

For more information, see [Access](/reference/settings).

Expand Down
2 changes: 1 addition & 1 deletion platform-overview/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Axiom enables you to take control over access to your data and features within A

Axiom provides you with searchable audit logs that provide you with comprehensive tracking of all activity in your Axiom organization to meet even the most stringent compliance requirements.

SAML-based SSO, role-based access control (RBAC), and full access to the audit log are available as add-ons if you’re on the Axiom Cloud plan, and they’re included by default on the Bring Your Own Cloud plan. For more information on ugrading, see the [Plan page](https://app.axiom.co/settings/plan) in your Axiom settings.
SAML-based SSO, role-based access control (RBAC), and full access to the audit log are available as add-ons on the Axiom Cloud plan. For more information, see [Manage add-ons](reference/usage-billing#manage-add-ons).

## Sub-processors

Expand Down
2 changes: 1 addition & 1 deletion reference/audit-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The audit log also make it easier to manage your Axiom organization. They allow
- Track changes made by your team to your observability posture.
- Track monitoring performance.

The audit log is available to all users. By default, you can query the audit log for the previous three days. You can request the ability to query the audit log for the full time range as an add-on if you’re on the Axiom Cloud plan, and it’s included by default on the Bring Your Own Cloud plan. For more information on ugrading, see the [Plan page](https://app.axiom.co/settings/plan) in your Axiom settings.
The audit log is available to all users. By default, you can query the audit log for the previous three days. You can request the ability to query the audit log for the full time range as an add-on on the Axiom Cloud plan. For more information, see [Manage add-ons](reference/usage-billing#manage-add-ons).

## Explore audit log

Expand Down
6 changes: 0 additions & 6 deletions reference/organization-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,3 @@ To delete your organization:
1. Back up your data. You aren’t able to access the data after deleting the org.
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > General**
1. Click **Delete organization**.

## Pricing plan and usage

To view details about your current plan and upgrade to a higher plan, click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Plan**.

To view details about your organization’s total usage of Axiom, click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Usage**.
6 changes: 5 additions & 1 deletion reference/regions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,8 @@ If your organization uses the EU region, change the base domain in the examples
| Region | Base domain of API endpoints | Example |
| ---------- | ------------------------------------ | ------------------------------------------------- |
| US | `https://api.axiom.co` | `https://api.axiom.co/v1/datasets/DATASET_NAME/ingest` |
| EU | `https://api.eu.axiom.co` | `https://api.eu.axiom.co/v1/datasets/DATASET_NAME/ingest` |
| EU | `https://api.eu.axiom.co` | `https://api.eu.axiom.co/v1/datasets/DATASET_NAME/ingest` |

## Add new region

For more information on managing additional regions, see [Manage add-ons](reference/usage-billing#manage-add-ons).
2 changes: 1 addition & 1 deletion reference/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Role-Based Access Control (RBAC) allows you to manage and restrict access to you
- [Single Sign-On (SAML SSO)](#single-sign-on-saml-sso)

<Note>
Role-based access control (RBAC), Directory Sync, and Single Sign-On (SAML SSO) are available as add-ons if you’re on the Axiom Cloud plan, and they’re included by default on the Bring Your Own Cloud plan. For more information on ugrading, see the [Plan page](https://app.axiom.co/settings/plan) in your Axiom settings.
Role-Based Access Control (RBAC), Directory Sync, and Single Sign-On (SAML SSO) are available as add-ons on the Axiom Cloud plan. For more information, see [Manage add-ons](reference/usage-billing#manage-add-ons).
</Note>

## Groups
Expand Down
108 changes: 108 additions & 0 deletions reference/usage-billing.mdx
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**.