Skip to content

Commit 91fec46

Browse files
committed
Changes as per review comments
1 parent 3924ad2 commit 91fec46

File tree

2 files changed

+26
-18
lines changed

2 files changed

+26
-18
lines changed

userguide/aviate/aviate-catalog-guide.adoc

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
== Introduction
44

5-
The http://aviate.killbill.io[Aviate Catalog UI] allows you to create individual catalog entries such as products, plans, and pricelists.
6-
This means you don’t need to manage entire catalog versions.
5+
The https://aviate.killbill.io[Aviate Catalog UI] allows you to create individual catalog entries such as products, plans, and pricelists.
6+
This provides much finer granularity than the Kill Bill open-source model, which requires creating a new catalog version for any change. As a result, this approach is more dynamic and scales significantly better when managing a large number of catalog entries.
77
Internally, the UI uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs].
88

99
== Create Product,Plan, Pricelist
@@ -53,10 +53,13 @@ Demo:
5353

5454
API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API].
5555

56+
[[edit_plan]]
5657
== Edit Plan
5758

58-
You can update *plan prices* after creation.
59-
Other attributes (like phase duration) cannot be changed.
59+
The edit plan feature allows you to update plan prices after a plan is created. Note that Other attributes (like *phase duration*) cannot be changed.
60+
61+
[NOTE]
62+
Editing a plan creates a new version of the plan. Existing subscriptions continue to use the old plan. See https://docs.killbill.io/latest/userguide_subscription#_catalog_versions[docs].
6063

6164
. Select the plan (e.g., `netflix-basic-monthly`).
6265
. Adjust the price.
@@ -79,7 +82,7 @@ API used: https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API
7982
== Archive Plan
8083

8184
You can archive an existing plan. Archiving prevents creating new subscriptions corresponding to the plan.
82-
Existing subscriptions remain active.
85+
The plan remains active for existing subscriptions.
8386

8487
. Select the plan (e.g., `Netflix Usage Monthly`).
8588
. Choose *Archive*.
@@ -102,7 +105,8 @@ API used: https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API
102105
== Delete Plan
103106

104107
You can delete an existing plan permanently. Deleting permanently removes a plan from the database.
105-
Use this only for plans created erroneously that do not have active subscriptions.
108+
109+
WARNING: Deleting a plan could break the system if there are active subscriptions. Use this only for plans created erroneously that do not have active subscriptions.
106110

107111
. Select the plan.
108112
. Choose *Delete*.
@@ -117,6 +121,10 @@ API used: https://apidocs.killbill.io/aviate-catalog#delete-plan[Delete Plan API
117121

118122
You can create a new plan based on an existing plan.
119123

124+
[NOTE]
125+
The *Duplicate Plan* feature is a time-saving convenience that lets you quickly create a new plan. When duplicating, all plan attributes can be edited and on saving,a new plan is created.
126+
By contrast, the <<edit_plan, Edit Plan>> feature is limited to updating prices only, and each change automatically generates a new version of the plan.
127+
120128
. Select the plan
121129
. Choose *Duplicate*
122130
. Make changes to the plan as desired
@@ -137,9 +145,9 @@ Demo:
137145

138146
== Creating Usage Plans
139147

140-
Usage plans allow billing based on consumption:
148+
Usage plans allow billing based on consumption. See https://docs.killbill.io/latest/userguide_subscription#components-catalog-usage[docs].
141149

142-
. Define a *billing meter* (how usage is tracked).
150+
. Define a https://apidocs.killbill.io/aviate-metering#billingmeter[billing meter] (how usage is tracked).
143151
. Configure *blocks/tiers*.
144152
. Assign usage-based prices to each block.
145153
. Save the plan.

userguide/aviate/aviate_getting_started.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this guide, you will:
1212

1313
The example company used throughout this guide is *CloudSprout*, a fictional SaaS business operating in the UK and France.
1414

15-
---
15+
''''
1616

1717
== Concepts Overview
1818

@@ -27,7 +27,7 @@ In short:
2727
* Use *Aviate* to *set things up*.
2828
* Use *Kaui* to *run billing operations*.
2929

30-
---
30+
''''
3131

3232
== Step 1: Start in Aviate (Get Started)
3333

@@ -61,7 +61,7 @@ The following demo shows how you can configure the company settings via Aviate.
6161
</div>
6262
++++
6363

64-
---
64+
''''
6565

6666
=== Configure the catalog
6767

@@ -99,7 +99,7 @@ image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/avi
9999

100100
This step only defines products and plans. No customers are created yet.
101101

102-
---
102+
''''
103103

104104
=== Configure taxes
105105

@@ -124,7 +124,7 @@ The following demo explains how you can configure the above tax codes:
124124
</div>
125125
++++
126126

127-
---
127+
''''
128128

129129
== Step 2: Switch to Kaui (Billing Operations)
130130

@@ -142,7 +142,7 @@ The following demo illustrates how you can switch to Kaui:
142142
</div>
143143
++++
144144

145-
---
145+
''''
146146

147147
=== Create your first customer
148148

@@ -153,7 +153,7 @@ In Kaui:
153153
. Select the appropriate currency (EUR or GBP).
154154
. Save the account.
155155

156-
---
156+
''''
157157

158158
The following demo illustrates the account creation process in Kaui:
159159

@@ -192,7 +192,7 @@ The following demo guides you through the subscription creation process in Kaui:
192192
</div>
193193
++++
194194

195-
---
195+
''''
196196

197197
=== View the invoice
198198

@@ -219,7 +219,7 @@ The following demo illustrates verifying the generated invoice:
219219
</div>
220220
++++
221221

222-
---
222+
''''
223223

224224
== What You Have Achieved
225225

@@ -235,7 +235,7 @@ By following this guide, you have:
235235

236236
You now have a fully working fictive SaaS company ready for demos or experimentation.
237237

238-
---
238+
''''
239239

240240
== Next Steps
241241

0 commit comments

Comments
 (0)