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/aviate-catalog-guide.adoc b/userguide/aviate/aviate-catalog-guide.adoc new file mode 100644 index 000000000..2c09374b9 --- /dev/null +++ b/userguide/aviate/aviate-catalog-guide.adoc @@ -0,0 +1,177 @@ += Aviate Catalog Guide + +== Introduction + +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]. + +== Create Product,Plan, Pricelist + +To create a product, plan, and pricelist: + +. 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: + +++++ +
+ +
+ +
+
+++++ + +API Used: https://apidocs.killbill.io/aviate-catalog#create-plan-product-pricelist[Create Plan, Product, Pricelist API]. + +== Add New Plan + +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. + + +Demo: + +++++ +
+ +
+ +
+
+++++ + +API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. + +== Edit Plan + +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. + + +Demo: + +++++ +
+ +
+ +
+
+++++ + +API used: https://apidocs.killbill.io/aviate-catalog#modify-plan[Modify Plan API]. + +== Archive Plan + +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. + + +Demo: + +++++ +
+ +
+ +
+
+++++ + +API used: https://apidocs.killbill.io/aviate-catalog#retire-plan[Retire Plan API]. + +== Delete Plan + +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. + + +//Demo: + +API used: 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 + +Usage plans allow billing based on consumption: + +. Define a *billing meter* (how usage is tracked). +. Configure *blocks/tiers*. +. Assign usage-based prices to each block. +. Save the plan. + + +Demo: + +++++ +
+ +
+ +
+
+++++ + +API used: https://apidocs.killbill.io/aviate-catalog#create-plan[Create Plan API]. + +//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 +* Duplicate plans +* Build usage-based plans + + + 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