Skip to content

Commit f30dc96

Browse files
committed
Update based on feedback
1 parent 45c8e06 commit f30dc96

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

docs/manage/manage/white-labelled-billing.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ To use custom billing, add a billing configuration to a fragment.
111111
1. Add the fragment to the machines that you want to bill for.
112112

113113
{{< tabs >}}
114-
{{% tab name="Full Template" %}}
114+
{{% tab name="Full Template (monthly)" %}}
115115

116116
```json
117117
{
@@ -129,9 +129,6 @@ To use custom billing, add a billing configuration to a fragment.
129129
"logs_data_upload_bytes": 0.0,
130130
"logs_data_egress_bytes": 0.0
131131
},
132-
"cost_per_year": {
133-
"per_machine": 0
134-
},
135132
"tier_name": "example-tier",
136133
"description": "",
137134
"tier_credit": 0.0,
@@ -141,55 +138,57 @@ To use custom billing, add a billing configuration to a fragment.
141138
```
142139

143140
{{% /tab %}}
144-
{{% tab name="Monthly Billing Example" %}}
145-
146-
This configuration charges customers every month in arrears, which means after usage:
141+
{{% tab name="Full Template (yearly)" %}}
147142

148-
```json { class="line-numbers linkable-line-numbers" }
143+
```json
149144
{
150145
"billing": {
151-
"cost_per_month": {
152-
"per_machine": 10
146+
"cost_per_year": {
147+
"per_machine": 0
153148
},
154-
"tier_name": "monthly-tier",
149+
"tier_name": "example-tier",
150+
"description": "",
151+
"tier_credit": 0.0,
155152
"in_arrears": true
156153
}
157154
}
158155
```
159156

160157
{{% /tab %}}
161-
{{% tab name="Annual Billing Example" %}}
158+
{{% tab name="Example (monthly)" %}}
162159

163-
This configuration charges customers every 12 months, with upfront payment:
160+
This configuration charges customers every month in arrears, which means after usage:
164161

165162
```json { class="line-numbers linkable-line-numbers" }
166163
{
167164
"billing": {
168-
"cost_per_year": {
169-
"per_machine": 100
165+
"cost_per_month": {
166+
"per_machine": 10,
167+
"binary_data_upload_bytes": 0.01
170168
},
171-
"tier_name": "annual-tier",
172-
"in_arrears": false
169+
"tier_name": "monthly-tier",
170+
"in_arrears": true
173171
}
174172
}
175173
```
176174

175+
By setting `"in_arrears": false` you can change the configuration to charge customers upfront.
176+
177+
If you want to charge customer
178+
177179
{{% /tab %}}
178-
{{% tab name="Combined Billing Example" %}}
180+
{{% tab name="Example (yearly)" %}}
179181

180-
This configuration charges customers both a monthly and an annual fee in arrears, which means after usage:
182+
This configuration charges customers every 12 months, with upfront payment:
181183

182184
```json { class="line-numbers linkable-line-numbers" }
183185
{
184186
"billing": {
185-
"cost_per_month": {
186-
"per_machine": 10
187-
},
188187
"cost_per_year": {
189188
"per_machine": 100
190189
},
191-
"tier_name": "flexible-tier",
192-
"in_arrears": true
190+
"tier_name": "annual-tier",
191+
"in_arrears": false
193192
}
194193
}
195194
```
@@ -202,12 +201,12 @@ This configuration charges customers both a monthly and an annual fee in arrears
202201
<!-- prettier-ignore -->
203202
| Name | Type | Required? | Description |
204203
| ---- | ---- | --------- | ----------- |
205-
| `cost_per_month` | object | Optional | See [cost per month attributes](/manage/manage/white-labelled-billing/#click-to-view-cost-per-month-attributes). Default: `{}` (all machines cost `0`). |
206-
| `cost_per_year` | object | Optional | See [cost per year attributes](/manage/manage/white-labelled-billing/#click-to-view-cost-per-year-attributes). Default: `{}` (all machines cost `0`). |
204+
| `cost_per_month` | object | Optional | See [cost per month attributes](/manage/manage/white-labelled-billing/#click-to-view-cost-per-month-attributes). If specified, you cannot also specify `cost_per_year`. Default: `{}` (all machines cost `0`). |
205+
| `cost_per_year` | object | Optional | See [cost per year attributes](/manage/manage/white-labelled-billing/#click-to-view-cost-per-year-attributes). If specified, you cannot also specify `cost_per_month`. Default: `{}` (all machines cost `0`). |
207206
| `tier_name` | string | **Required** | The name of the billing tier. |
208207
| `description` | string | Optional | Description for the billing tier. Default: `""`. |
209208
| `tier_credit` | number | Optional | Credit that should be applied to final total for the org. Default: `0`. |
210-
| `in_arrears` | boolean | Optional | Whether billing is charged in arrears (after usage) or upfront. Set to `true` for monthly billing in arrears, `false` for upfront annual billing. Default: `true`. |
209+
| `in_arrears` | boolean | Optional | Whether billing is charged in arrears (after usage) or upfront. For monthly billing, set to `true` for billing in arrears and `false` for upfront billing. For annual billing, `in_arrears` must be set to `false`. Default: `true`. |
211210

212211
{{% /expand%}}
213212

@@ -256,9 +255,14 @@ Renewal is automatic for both monthly and annual billing.
256255
### When are invoices generated?
257256

258257
- **Monthly billing (`in_arrears: true`)**: Invoiced are generated and customers are charged at the end of each month for usage during that month.
259-
The 1-month period starts from the initial subscription date.
258+
The first 1-month period starts from the subscription date.
259+
Afterwards each new month starts on the next day after the previous usage month's end.
260+
- **Monthly billing (`in_arrears: false`)**: Invoiced are generated and customers are charged at the beginning of each new month of usage.
261+
The first 1-month period starts from the subscription date.
262+
Afterwards each new month starts on the next day after the previous usage month's end.
260263
- **Annual billing (`in_arrears: false`)**: Invoiced are generated and customers are charged upfront at the beginning of each 12-month period.
261264
The 12-month period starts from the initial subscription date.
265+
Each new 12-month period starts on the next day after the pervious 12-month period's end.
262266

263267
### Can customers switch from monthly to annual?
264268

0 commit comments

Comments
 (0)