From 27c62b426cff25b62e9ae23fb7f77aeb1c11794c Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Thu, 29 Jan 2026 13:31:45 +0530 Subject: [PATCH 1/6] Aviate-catalog doc --- userguide/aviate/aviate-pricing-hub.adoc | 6 +- .../aviate/includes/aviate-catalog-guide.adoc | 58 +++++++++++++++++++ 2 files changed, 61 insertions(+), 3 deletions(-) create mode 100644 userguide/aviate/includes/aviate-catalog-guide.adoc diff --git a/userguide/aviate/aviate-pricing-hub.adoc b/userguide/aviate/aviate-pricing-hub.adoc index ef2ef1b95..09881a423 100644 --- a/userguide/aviate/aviate-pricing-hub.adoc +++ b/userguide/aviate/aviate-pricing-hub.adoc @@ -1,9 +1,9 @@ -= Aviate Pricing Hub += Aviate Catalog Guide == Introduction -The Aviate Pricing Hub allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. -The Pricing Hub UI internally uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. +The Aviate Catalog UI allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. +The Aviate Catalog UI internally uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. == Products diff --git a/userguide/aviate/includes/aviate-catalog-guide.adoc b/userguide/aviate/includes/aviate-catalog-guide.adoc new file mode 100644 index 000000000..87c4d8abd --- /dev/null +++ b/userguide/aviate/includes/aviate-catalog-guide.adoc @@ -0,0 +1,58 @@ += Aviate Catalog Guide + +== Introduction + +The Aviate Catalog UI allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. +The Aviate Catalog UI internally uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. + +== Products + +The Products screen provides information about the available products. It can be used to create products/plans/pricelists. It can also be used to edit existing plans/products and retire plans/products. + +=== Create Product,Plan, Pricelist + +The Create Product, Plan, Pricelist screen can be used to create a product, plan, and pricelist. + +You can refer to https://killbill.storylane.io/share/elbar7il3dvs[this demo]. + +The above demo creates a new product called `netflix` with a `netflix-basic-monthly` plan that is priced at `$10` per month. + +This UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan-product-pricelist[Create Plan, Product, Pricelist API]. + +=== Add New Plan + +Once a product is created, you can add new plans at any time. + +You can refer to https://killbill.storylane.io/share/h0mwfwocymqr[this demo] + +The above demo creates a new plan called `netflix-premium-monthly` corresponding to the `netflix` product. It has a `DISCOUNT` and `EVERGREEN` phase. + +The UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. + +=== Edit Plan + +The Aviate Catalog UI allows modifying plan prices after a plan is created. Note that only plan prices can be modified, other plan attributes like duration of the phases, etc. are not allowed to be changed. + +You can refer to https://killbill.storylane.io/share/4unxvpnzucbe[this demo]. + +The above demo modifies the prices of the `netflix-basic-monthly` plan. + +The UI internally uses the https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. + +=== Retire Plan + +The Aviate Catalog UI allows retiring a plan. When a plan is retired, it is no longer possible to create new subscriptions corresponding to the plan. + +//TODO - Add the demo once the UI bug is fixed +// You can refer to [this demo]. + +The UI internally uses the https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. + +=== Creating Usage Plans + +The Aviate Catalog UI also allows creating usage plans. So you can define a billing meter (which encapsulates how usages are aggregated), define blocks/tiers in the usage plan, and add usage based prices corresponding to these blocks. + +You can refer to https://killbill.storylane.io/share/wst70zfovkue[this demo]. + + +image::../assets/img/aviate/pricing-hub-guide/usage-pricing.png[] From 61a330c09625dd69fab85de5c2b527e93d776a6d Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Thu, 29 Jan 2026 15:11:31 +0530 Subject: [PATCH 2/6] added left nav and moved the document to the right directory --- html5/_main_toc.html.slim | 4 ++-- userguide/aviate/{includes => }/aviate-catalog-guide.adoc | 0 2 files changed, 2 insertions(+), 2 deletions(-) rename userguide/aviate/{includes => }/aviate-catalog-guide.adoc (100%) diff --git a/html5/_main_toc.html.slim b/html5/_main_toc.html.slim index a8e61533c..52896d092 100644 --- a/html5/_main_toc.html.slim +++ b/html5/_main_toc.html.slim @@ -354,8 +354,8 @@ nav.sidebar-nav a.nav-link href="/latest/aviate-changelog.html" | Aviate Changelog li.bd-sidenav-active - a.nav-link href="/latest/aviate-pricing-hub.html" - | Aviate Pricing Hub Guide + a.nav-link href="/latest/aviate-catalog-guide.html" + | Aviate Catalog Guide li.bd-sidenav-active a.nav-link href="/latest/how-to-install-the-aviate-plugin.html" | Plugin Installation diff --git a/userguide/aviate/includes/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc similarity index 100% rename from userguide/aviate/includes/aviate-catalog-guide.adoc rename to userguide/aviate/aviate-catalog-guide.adoc From f4cca8675a9d38840233d9e006c15923dcccf19a Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Thu, 29 Jan 2026 15:21:15 +0530 Subject: [PATCH 3/6] embed demos, other minor corrections --- userguide/aviate/aviate-catalog-guide.adoc | 49 +++++++++++++++++++--- 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/userguide/aviate/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc index 87c4d8abd..d40badb4b 100644 --- a/userguide/aviate/aviate-catalog-guide.adoc +++ b/userguide/aviate/aviate-catalog-guide.adoc @@ -2,7 +2,7 @@ == Introduction -The Aviate Catalog UI allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. +The http://aviate.killbill.io[Aviate Catalog UI] allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. The Aviate Catalog UI internally uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. == Products @@ -13,7 +13,16 @@ The Products screen provides information about the available products. It can be The Create Product, Plan, Pricelist screen can be used to create a product, plan, and pricelist. -You can refer to https://killbill.storylane.io/share/elbar7il3dvs[this demo]. +You can refer to the following demo: + +++++ +
+ +
+ +
+
+++++ The above demo creates a new product called `netflix` with a `netflix-basic-monthly` plan that is priced at `$10` per month. @@ -23,7 +32,16 @@ This UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-pl Once a product is created, you can add new plans at any time. -You can refer to https://killbill.storylane.io/share/h0mwfwocymqr[this demo] +You can refer to the following demo: + +++++ +
+ +
+ +
+
+++++ The above demo creates a new plan called `netflix-premium-monthly` corresponding to the `netflix` product. It has a `DISCOUNT` and `EVERGREEN` phase. @@ -33,7 +51,16 @@ The UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-pla The Aviate Catalog UI allows modifying plan prices after a plan is created. Note that only plan prices can be modified, other plan attributes like duration of the phases, etc. are not allowed to be changed. -You can refer to https://killbill.storylane.io/share/4unxvpnzucbe[this demo]. +You can refer to the following demo: + +++++ +
+ +
+ +
+
+++++ The above demo modifies the prices of the `netflix-basic-monthly` plan. @@ -52,7 +79,17 @@ The UI internally uses the https://apidocs.killbill.io/aviate-catalog#retire-pla The Aviate Catalog UI also allows creating usage plans. So you can define a billing meter (which encapsulates how usages are aggregated), define blocks/tiers in the usage plan, and add usage based prices corresponding to these blocks. -You can refer to https://killbill.storylane.io/share/wst70zfovkue[this demo]. +You can refer to the following demo: + +++++ +
+ +
+ +
+
+++++ +//TODO Delete Plan/Product -image::../assets/img/aviate/pricing-hub-guide/usage-pricing.png[] +//TODO Duplicate Plan/Product From be0ce1117716caf8a6cd1b67eaaa3b5f8c18f379 Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Tue, 3 Feb 2026 18:12:42 +0530 Subject: [PATCH 4/6] additional sections --- userguide/aviate/aviate-catalog-guide.adoc | 30 +++++++++++++++++++--- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/userguide/aviate/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc index d40badb4b..6e4d90672 100644 --- a/userguide/aviate/aviate-catalog-guide.adoc +++ b/userguide/aviate/aviate-catalog-guide.adoc @@ -66,15 +66,37 @@ The above demo modifies the prices of the `netflix-basic-monthly` plan. The UI internally uses the https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. -=== Retire Plan +=== Archive Plan -The Aviate Catalog UI allows retiring a plan. When a plan is retired, it is no longer possible to create new subscriptions corresponding to the plan. +The Aviate Catalog UI allows archiving a plan. When a plan is archived, it is no longer possible to create new subscriptions corresponding to the plan. Existing subscriptions continue to work. -//TODO - Add the demo once the UI bug is fixed -// You can refer to [this demo]. +You can refer to the following demo: + +++++ +
+ +
+ +
+
+++++ + +The above demo archives the `Netflix Usage Monthly` plan. The UI internally uses the https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. +=== Delete Plan + +The Aviate Catalog UI allows deleting a plan permanently. Note that deleting a plan hard deletes it from the database and will affect existing subscriptions. This operation should only typically be performed on plans created erroneously to which there are no subscriptions. + +//You can refer to the following demo: + +//The above demo deletes the `temp` plan. + +The UI internally uses the https://apidocs.killbill.io/aviate-catalog#delete-plan[Delete Plan API]. + + + === Creating Usage Plans The Aviate Catalog UI also allows creating usage plans. So you can define a billing meter (which encapsulates how usages are aggregated), define blocks/tiers in the usage plan, and add usage based prices corresponding to these blocks. From 9b1f2756b26dbc34ebcf5ad3a3dce10c24b6c0b6 Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Tue, 3 Feb 2026 18:25:35 +0530 Subject: [PATCH 5/6] minor re-structuring --- userguide/aviate/aviate-catalog-guide.adoc | 34 ++++++++++++++-------- 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/userguide/aviate/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc index 6e4d90672..15e674e81 100644 --- a/userguide/aviate/aviate-catalog-guide.adoc +++ b/userguide/aviate/aviate-catalog-guide.adoc @@ -2,14 +2,11 @@ == Introduction -The http://aviate.killbill.io[Aviate Catalog UI] allows creating individual catalog entries such as plans, products, and pricelists. Thus, you can create such entries without the need to manage entire catalog versions. -The Aviate Catalog UI internally uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. +The http://aviate.killbill.io[Aviate Catalog UI] allows you to create individual catalog entries such as products, plans, and pricelists. +This means you don’t need to manage entire catalog versions. +Internally, the UI uses the https://apidocs.killbill.io/aviate-catalog[Aviate Catalog APIs]. -== Products - -The Products screen provides information about the available products. It can be used to create products/plans/pricelists. It can also be used to edit existing plans/products and retire plans/products. - -=== Create Product,Plan, Pricelist +== Create Product,Plan, Pricelist The Create Product, Plan, Pricelist screen can be used to create a product, plan, and pricelist. @@ -28,7 +25,7 @@ The above demo creates a new product called `netflix` with a `netflix-basic-mont This UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan-product-pricelist[Create Plan, Product, Pricelist API]. -=== Add New Plan +== Add New Plan Once a product is created, you can add new plans at any time. @@ -47,7 +44,7 @@ The above demo creates a new plan called `netflix-premium-monthly` corresponding The UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. -=== Edit Plan +== Edit Plan The Aviate Catalog UI allows modifying plan prices after a plan is created. Note that only plan prices can be modified, other plan attributes like duration of the phases, etc. are not allowed to be changed. @@ -66,7 +63,7 @@ The above demo modifies the prices of the `netflix-basic-monthly` plan. The UI internally uses the https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. -=== Archive Plan +== Archive Plan The Aviate Catalog UI allows archiving a plan. When a plan is archived, it is no longer possible to create new subscriptions corresponding to the plan. Existing subscriptions continue to work. @@ -85,7 +82,7 @@ The above demo archives the `Netflix Usage Monthly` plan. The UI internally uses the https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. -=== Delete Plan +== Delete Plan The Aviate Catalog UI allows deleting a plan permanently. Note that deleting a plan hard deletes it from the database and will affect existing subscriptions. This operation should only typically be performed on plans created erroneously to which there are no subscriptions. @@ -97,7 +94,7 @@ The UI internally uses the https://apidocs.killbill.io/aviate-catalog#delete-pla -=== Creating Usage Plans +== Creating Usage Plans The Aviate Catalog UI also allows creating usage plans. So you can define a billing meter (which encapsulates how usages are aggregated), define blocks/tiers in the usage plan, and add usage based prices corresponding to these blocks. @@ -115,3 +112,16 @@ You can refer to the following demo: //TODO Delete Plan/Product //TODO Duplicate Plan/Product + +== Conclusion + +You now know how to: + +* Create products, plans, and pricelists +* Add new plans +* Edit plan prices +* Archive or delete plans +* Build usage-based plans + + + From a5cb119ef3d7d44270afdb8d17a6998a2052b537 Mon Sep 17 00:00:00 2001 From: Reshma Bidikar Date: Wed, 4 Feb 2026 11:46:08 +0530 Subject: [PATCH 6/6] Additional demos/doc enhancements --- userguide/aviate/aviate-catalog-guide.adoc | 102 +++++++++++++++------ 1 file changed, 76 insertions(+), 26 deletions(-) diff --git a/userguide/aviate/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc index 15e674e81..2c09374b9 100644 --- a/userguide/aviate/aviate-catalog-guide.adoc +++ b/userguide/aviate/aviate-catalog-guide.adoc @@ -8,9 +8,16 @@ Internally, the UI uses the https://apidocs.killbill.io/aviate-catalog[Aviate Ca == Create Product,Plan, Pricelist -The Create Product, Plan, Pricelist screen can be used to create a product, plan, and pricelist. +To create a product, plan, and pricelist: -You can refer to the following demo: +. Open the *Create Product, Plan, Pricelist* screen. +. Enter the product name (e.g., `netflix`). +. Define a plan (e.g., `netflix-basic-monthly`). +. Set the price (e.g., `$10` per month). +. Save your entries. + + +Demo: ++++
@@ -21,15 +28,19 @@ You can refer to the following demo:
++++ -The above demo creates a new product called `netflix` with a `netflix-basic-monthly` plan that is priced at `$10` per month. - -This UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan-product-pricelist[Create Plan, Product, Pricelist API]. +API Used: https://apidocs.killbill.io/aviate-catalog#create-plan-product-pricelist[Create Plan, Product, Pricelist API]. == Add New Plan -Once a product is created, you can add new plans at any time. +Once a product exists, you can add additional plans: + +. Select the product (e.g., `netflix`). +. Create a new plan (e.g., `netflix-premium-monthly`). +. Configure phases such as `DISCOUNT` or `EVERGREEN`. +. Save the plan. -You can refer to the following demo: + +Demo: ++++
@@ -40,15 +51,19 @@ You can refer to the following demo:
++++ -The above demo creates a new plan called `netflix-premium-monthly` corresponding to the `netflix` product. It has a `DISCOUNT` and `EVERGREEN` phase. - -The UI internally uses the https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. +API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. == Edit Plan -The Aviate Catalog UI allows modifying plan prices after a plan is created. Note that only plan prices can be modified, other plan attributes like duration of the phases, etc. are not allowed to be changed. +You can update *plan prices* after creation. +Other attributes (like phase duration) cannot be changed. + +. Select the plan (e.g., `netflix-basic-monthly`). +. Adjust the price. +. Save changes. -You can refer to the following demo: + +Demo: ++++
@@ -59,15 +74,19 @@ You can refer to the following demo:
++++ -The above demo modifies the prices of the `netflix-basic-monthly` plan. - -The UI internally uses the https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. +API used: https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. == Archive Plan -The Aviate Catalog UI allows archiving a plan. When a plan is archived, it is no longer possible to create new subscriptions corresponding to the plan. Existing subscriptions continue to work. +You can archive an existing plan. Archiving prevents creating new subscriptions corresponding to the plan. +Existing subscriptions remain active. + +. Select the plan (e.g., `Netflix Usage Monthly`). +. Choose *Archive*. +. Confirm the action. + -You can refer to the following demo: +Demo: ++++
@@ -78,27 +97,55 @@ You can refer to the following demo:
++++ -The above demo archives the `Netflix Usage Monthly` plan. - -The UI internally uses the https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. +API used: https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. == Delete Plan -The Aviate Catalog UI allows deleting a plan permanently. Note that deleting a plan hard deletes it from the database and will affect existing subscriptions. This operation should only typically be performed on plans created erroneously to which there are no subscriptions. +You can delete an existing plan permanently. Deleting permanently removes a plan from the database. +Use this only for plans created erroneously that do not have active subscriptions. + +. Select the plan. +. Choose *Delete*. +. Confirm deletion. + -//You can refer to the following demo: +//Demo: -//The above demo deletes the `temp` plan. +API used: https://apidocs.killbill.io/aviate-catalog#delete-plan[Delete Plan API]. -The UI internally uses the https://apidocs.killbill.io/aviate-catalog#delete-plan[Delete Plan API]. +== Duplicate Plan + +You can create a new plan based on an existing plan. + +. Select the plan +. Choose *Duplicate* +. Make changes to the plan as desired +. Save the new plan. + +Demo: + +++++ +
+ +
+ +
+
+++++ == Creating Usage Plans -The Aviate Catalog UI also allows creating usage plans. So you can define a billing meter (which encapsulates how usages are aggregated), define blocks/tiers in the usage plan, and add usage based prices corresponding to these blocks. +Usage plans allow billing based on consumption: -You can refer to the following demo: +. Define a *billing meter* (how usage is tracked). +. Configure *blocks/tiers*. +. Assign usage-based prices to each block. +. Save the plan. + + +Demo: ++++
@@ -109,6 +156,8 @@ You can refer to the following demo:
++++ +API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. + //TODO Delete Plan/Product //TODO Duplicate Plan/Product @@ -121,6 +170,7 @@ You now know how to: * Add new plans * Edit plan prices * Archive or delete plans +* Duplicate plans * Build usage-based plans