Skip to content

Commit 58c374b

Browse files
authored
Document billing (#3812)
* Document billing * Add info on calculations * Review explanations on estimates * Small fixes * Other small fixes * Fix copy paste * Apply suggestions from review * Add screenshots * Update formula
1 parent a3e5c33 commit 58c374b

File tree

10 files changed

+210
-38
lines changed

10 files changed

+210
-38
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Billing"
3+
weight: 2
4+
description: Keep your billing details up to date and optimize cost management from the Console.
5+
---
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Administer your billing
3+
weight: 1
4+
description: Keep your billing information up to date and redeem your vouchers from the Console.
5+
---
6+
7+
The [Console](/administration/web/_index.md) is where you can keep your billing details up to date and redeem your vouchers.
8+
9+
## Manage your billing details
10+
11+
To add or edit billing details for your organization, follow these steps:
12+
13+
1. Navigate to your organization.
14+
2. Open the user menu (your name or profile picture).
15+
3. Click **Billing**.</br>
16+
4. Open the **Billing details** tab.
17+
5. Add or update your billing details and click **Save**.
18+
6. Add or update your payment method and click **Submit**.
19+
20+
## Redeem a voucher
21+
22+
To redeem a voucher, follow these steps:
23+
24+
1. Navigate to your organization.
25+
2. Open the user menu (your name or profile picture).
26+
3. Click **Billing**.</br>
27+
4. Open the **Vouchers** tab.
28+
5. Enter your voucher code.
29+
6. Click **Redeem**.
Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
title: Monitor your billing information
3+
weight: 2
4+
description: Manage your costs efficiently by viewing monthly spend estimates and setting spend alerts.
5+
keywords:
6+
- "resources"
7+
- "flexible resources"
8+
- "CPU"
9+
- "RAM"
10+
- "disk storage"
11+
- "costs"
12+
- "invoice"
13+
- "monthly spending"
14+
- "billing"
15+
---
16+
17+
To help you manage costs related to your organization,
18+
Upsun provides estimates for the current month and the next.
19+
20+
You can set billing alerts to ensure you don't overspend,
21+
and track resource usage on each of your projects.
22+
23+
For details on costs, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).
24+
25+
## Access your organization billing information
26+
27+
To access your organization billing information in the [Console](/administration/web/_index.md):
28+
29+
1. Navigate to your organization.
30+
2. Open the user menu (your name or profile picture).
31+
3. Click **Billing**.</br>
32+
The **Overview** tab is displayed.
33+
You can view your current month and next month estimates.
34+
35+
![Organization billing information in the Overview tab](/images/billing/organization-billing.png "0.6")
36+
37+
### Current month estimate
38+
39+
The [**Overview** tab](#access-your-organization-billing-information) shows an estimate of how much you may be charged at the end of this month.</br>
40+
This estimate is based on:
41+
42+
- Your organization settings (user management settings, number of projects, potential add-ons, support SLA, etc.)
43+
- Your resource allocation on each project
44+
45+
The estimate includes the history of changes made since the beginning of the month.
46+
**It cannot be 100% accurate, as it is impossible to know exactly what your future usage will be.**</br>
47+
However, for maximum accuracy, the current month estimate includes three underlying estimates,
48+
each with its own calculation:
49+
50+
- A [user management estimate](#user-management-estimate)
51+
- An [accumulated resource usage estimate](#accumulated-resource-usage-estimate)
52+
- An [allocated resource usage estimate](#allocated-resource-usage-estimate)
53+
54+
#### User management estimate
55+
56+
The following formula is used to estimate how much user license and user management add-on fees may cost you this month:</br>
57+
`unit price x prorated quantity`.
58+
59+
| Item | Description |
60+
| ------------------ | ----------- |
61+
| `unit price` | A fixed unit price. |
62+
| `prorated quantity`| An average of past changes and current settings, applied for all the remaining days in the month. |
63+
64+
All items used for the calculation are displayed in the **Overview** tab.
65+
66+
#### Accumulated resource usage estimate
67+
68+
The resources consumed for builds, bandwidth, and log forwarding are accumulated resources.</br>
69+
The following formula is used to estimate how much accumulated resource usage may cost you this month:</br>
70+
`current accumulation + (unit price x daily average x remaining days in the month)`.
71+
72+
| Item | Description |
73+
| ---------------------- | ----------- |
74+
| `current accumulation` | The amount of accumulated resources you have effectively used so far this month. |
75+
| `unit price` | A fixed unit price. |
76+
| `daily average` | An average based on the accumulated resource usage you've had over the last 30 days. |
77+
78+
All items used for the calculation are displayed in the [**Overview** tab](#access-your-organization-billing-information).
79+
80+
#### Allocated resource usage estimate
81+
82+
The resources consumed by your applications and services (CPU, RAM, and storage) are allocated resources.</br>
83+
The following formula is used to estimate how much allocated resource usage may cost you this month:</br>
84+
`unit price x prorated quantity`.
85+
86+
| Item | Description |
87+
| -------------------- | ----------- |
88+
| `unit price` | A fixed unit price. |
89+
| `prorated quantity` | An average of past changes and current settings, applied for all the remaining days in the month. |
90+
91+
All items used for the calculation are displayed in the [**Overview** tab](#access-your-organization-billing-information).
92+
93+
### Next month estimate
94+
95+
From the [**Overview** tab](#access-your-organization-billing-information), you can also access an estimate for next month.
96+
97+
Like your [current month estimate](#current-month-estimate), it includes your organization settings and resource allocation on each project.
98+
However, your next month estimate **does not include any history of changes**.
99+
100+
It is solely based on your current organization settings and resource allocation,
101+
and shows what you may be charged if you don't make any changes until the end of next month.
102+
103+
The following formulas are used:
104+
105+
- `unit price x current allocation` to estimate how much user license, user management add-on fees,
106+
and allocated resources may respectively cost you next month.
107+
108+
- `unit price x daily average x 30 days` to estimate how much accumulated resources may cost you next month.
109+
110+
### Invoice
111+
112+
Your invoice provides definitive information on what you will be charged.
113+
It is calculated at month-end close, and includes your actual organization settings and resource usage.
114+
115+
To access your current invoice and a history of past invoices, open the **Invoices** tab:
116+
117+
![Invoices tab in the Console](/images/billing/invoices-tab.png)
118+
119+
## Set a billing alert
120+
121+
{{% note theme="info" title="Feature availability" %}}
122+
123+
Billing alerts can only be set and received by the organization owner,
124+
users with the [**Manage Billing** permission](/administration/users.md#organization-permissions),
125+
and identified billing contacts.
126+
127+
{{% /note %}}
128+
129+
You can set billing alerts to receive an email when your [current month estimate](#current-month-estimate) reaches a defined threshold.
130+
131+
{{% note theme="warning" title="Warning"%}}
132+
Current month estimates are computed once a day only.
133+
Therefore, email notifications can only be triggered once a day too.
134+
135+
You may want to increase your billing alert threshold after receiving an email notification.
136+
However, if the new threshold is reached later on the same day,
137+
**you won't get notified until the following day**, when the current month estimate is computed again.
138+
{{% /note %}}
139+
140+
To set a billing alert on your organization:
141+
142+
1. Navigate to your organization.
143+
2. Open the user menu (your name or profile picture).
144+
3. Click **Billing**.</br>
145+
4. In the **Overview** tab, click **Set alert**.
146+
5. Enter a threshold.
147+
6. Click **Create alert**.
148+
149+
Note that you can edit or delete a billing alert by clicking the billing alert button in the **Overview** tab:
150+
![Billing alert button in the Console](/images/billing/billing-alert-button.png "0.1")
151+
152+
## Track resource usage on a project
153+
154+
{{% note theme="info" title="Feature availability" %}}
155+
156+
This feature is available to users with the [**Manage Billing** permission](/administration/users.md#organization-permissions) on the organization.
157+
158+
{{% /note %}}
159+
160+
You can track costs related to resource usage on a specific project in the [Console](/administration/web/_index.md).
161+
To do so, after you've set or updated resources on your project:
162+
163+
1. Navigate to your organization.
164+
2. Open the user menu (your name or profile picture).
165+
3. Click **Billing**.</br>
166+
Your [current month estimate](#current-month-estimate) shows how much each project in your organization is expected to cost this month.
167+
4. You can select a project to view resource allocation and usage details.</br>
168+
To do so, click **{{< icon more >}} More** next to it, and select **Project Billing**.</br>
169+
![Project billing information in the Overview tab](/images/billing/project-billing.png "0.6")
170+
171+
For information on resource-related costs, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).
172+
173+

sites/friday/src/manage-resources/adjust-resources.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ You can even scale horizontally if your apps are struggling with high load, or i
3232
by adding more instances for your apps and workers.
3333

3434
For information on costs related to resource usage, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).
35-
To keep an eye on those costs in the Console, see [Resource Billing](/manage-resources/resource-billing.md).
35+
36+
Note that you can [monitor these costs](/administration/billing/monitor-billing.md) in the Console.
3637

3738
## Vertical scaling
3839

sites/friday/src/manage-resources/resource-billing.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

sites/friday/src/manage-resources/resource-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can also [adjust resources](/manage-resources/adjust-resources.md) after you
3737
{{% note %}}
3838

3939
For information on costs related to resource usage, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).
40-
Note that you can [keep an eye on those costs](/manage-resources/resource-billing.md) in the Console.
40+
Note that you can [monitor these costs](/administration/billing/monitor-billing.md) in the Console.
4141

4242
{{% /note %}}
4343

Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)