You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: userguide/aviate/aviate-catalog-guide.adoc
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
3
3
== Introduction
4
4
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.
7
7
Internally, the UI uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs].
8
8
9
9
== Create Product,Plan, Pricelist
@@ -53,10 +53,13 @@ Demo:
53
53
54
54
API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API].
55
55
56
+
[[edit_plan]]
56
57
== Edit Plan
57
58
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].
60
63
61
64
. Select the plan (e.g., `netflix-basic-monthly`).
62
65
. Adjust the price.
@@ -79,7 +82,7 @@ API used: https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API
79
82
== Archive Plan
80
83
81
84
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.
83
86
84
87
. Select the plan (e.g., `Netflix Usage Monthly`).
85
88
. Choose *Archive*.
@@ -102,7 +105,8 @@ API used: https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API
102
105
== Delete Plan
103
106
104
107
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.
106
110
107
111
. Select the plan.
108
112
. Choose *Delete*.
@@ -117,6 +121,10 @@ API used: https://apidocs.killbill.io/aviate-catalog#delete-plan[Delete Plan API
117
121
118
122
You can create a new plan based on an existing plan.
119
123
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
+
120
128
. Select the plan
121
129
. Choose *Duplicate*
122
130
. Make changes to the plan as desired
@@ -137,9 +145,9 @@ Demo:
137
145
138
146
== Creating Usage Plans
139
147
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].
141
149
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).
0 commit comments