Aviate catalog guide/Getting Started Doc by reshmabidikar · Pull Request #641 · killbill/killbill-docs

reshmabidikar · 2026-01-29T10:30:22Z

Version 1 of Aviate catalog with Storylane demos - As and when the other UI features (delete plan/product, duplicate product, etc.) are available, I will add these to the demo.
Version 1 of the Getting Started Guide

userguide/aviate/aviate_getting_started.adoc

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


userguide/aviate/aviate_getting_started.adoc

+* Use *Aviate* to *set things up*.
+* Use *Kaui* to *run billing operations*.
+
+---


userguide/aviate/aviate_getting_started.adoc

+</div>
++++
+
+---


userguide/aviate/aviate_getting_started.adoc

+
+This step only defines products and plans. No customers are created yet.
+
+---


userguide/aviate/aviate_getting_started.adoc

+</div>
++++
+
+---


userguide/aviate/aviate_getting_started.adoc

+</div>
++++
+
+---


userguide/aviate/aviate_getting_started.adoc

+. Select the appropriate currency (EUR or GBP).
+. Save the account.
+
+---


userguide/aviate/aviate_getting_started.adoc

+</div>
++++
+
+---


userguide/aviate/aviate_getting_started.adoc

+</div>
++++
+
+---


userguide/aviate/aviate_getting_started.adoc

+
+You now have a fully working fictive SaaS company ready for demos or experimentation.
+
+---


sbrossie · 2026-02-06T16:49:28Z

userguide/aviate/aviate-catalog-guide.adoc

+
+== Introduction
+
+The http://aviate.killbill.io[Aviate Catalog UI] allows you to create individual catalog entries such as products, plans, and pricelists.


typo: http ->https

sbrossie · 2026-02-06T16:55:15Z

userguide/aviate/aviate-catalog-guide.adoc

+== 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.


Suggestion:
'This means you don’t need to manage entire catalog versions.' -> 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.

sbrossie · 2026-02-06T16:57:38Z

userguide/aviate/aviate-catalog-guide.adoc

+<div>
+  <script async src="https://js.storylane.io/js/v2/storylane.js"></script>
+  <div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
+    <iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/elbar7il3dvs?embed=popup" name="sl-embed" allow="fullscreen" allowfullscreen style="position:absolute;top:0;left:0;width:100%!important;height:100%!important;border:1px solid rgba(63,95,172,0.35);box-shadow: 0px 0px 18px rgba(26, 19, 72, 0.15);border-radius:10px;box-sizing:border-box;"></iframe>


Regarding storylane:
• I think it would be best to not use Netflix as a product
• Also, could we make it a video instead of having users to click through each steps?

sbrossie · 2026-02-06T19:50:15Z

userguide/aviate/aviate-catalog-guide.adoc

+<div>
+  <script async src="https://js.storylane.io/js/v2/storylane.js"></script>
+  <div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
+    <iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/h0mwfwocymqr?embed=popup" name="sl-embed" allow="fullscreen" allowfullscreen style="position:absolute;top:0;left:0;width:100%!important;height:100%!important;border:1px solid rgba(63,95,172,0.35);box-shadow: 0px 0px 18px rgba(26, 19, 72, 0.15);border-radius:10px;box-sizing:border-box;"></iframe>


Same remark on the storylane. I think a video would be better, it's a lot of clicks.

Also, call to action redirects to https://killbill.io/ \cc @pierre to be discussed.

sbrossie · 2026-02-06T19:53:22Z

userguide/aviate/aviate-catalog-guide.adoc

+== Edit Plan
+
+You can update *plan prices* after creation.
+Other attributes (like phase duration) cannot be changed.


We should explain that in this case, the model is to create a new plan - and possibly retire the old one if not used anymore.

Also, explain that this will create a new version of the plan and existing subscription will use the old plan. You could even point to the subscription manual https://docs.killbill.io/latest/userguide_subscription#_catalog_versions

sbrossie · 2026-02-06T19:53:55Z

userguide/aviate/aviate-catalog-guide.adoc

+== Archive Plan
+
+You can archive an existing plan. Archiving prevents creating new subscriptions corresponding to the plan.
+Existing subscriptions remain active.


The plan remains active for existing subscriptions.

sbrossie · 2026-02-06T19:54:52Z

userguide/aviate/aviate-catalog-guide.adoc

+== 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.


Add a warning that it could break the system if there are active subscriptions.

sbrossie · 2026-02-06T19:56:49Z

userguide/aviate/aviate-catalog-guide.adoc

+
+. Select the plan
+. Choose *Duplicate*
+. Make changes to the plan as desired


Explain this is purely for convenience and everything can be edited changed - as opposed to the edit functionality that only allows to update prices.

sbrossie · 2026-02-06T20:00:58Z

userguide/aviate/aviate-catalog-guide.adoc

+Usage plans allow billing based on consumption:
+
+. Define a *billing meter* (how usage is tracked).
+. Configure *blocks/tiers*.


Point to the doc that defines billing meter and the kill bill doc that talks about usage: https://docs.killbill.io/latest/userguide_subscription#components-catalog-usage

reshmabidikar added 7 commits January 29, 2026 13:31

Aviate-catalog doc

27c62b4

Merge remote-tracking branch 'origin/v3' into update-aviate-docs

433ca32

added left nav and moved the document to the right directory

61a330c

embed demos, other minor corrections

f4cca86

additional sections

be0ce11

minor re-structuring

9b1f275

Additional demos/doc enhancements

a5cb119

reshmabidikar requested review from pierre and sbrossie February 4, 2026 06:17

Getting Started - First Draft

3924ad2

reshmabidikar changed the title ~~Aviate catalog guide~~ Aviate catalog guide/Getting Started Doc Feb 6, 2026

github-advanced-security bot found potential problems Feb 6, 2026

View reviewed changes

sbrossie reviewed Feb 6, 2026

View reviewed changes

sbrossie mentioned this pull request Feb 6, 2026

Update change log #643

Open


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

		---


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

		---


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

		---


		== Introduction

		The http://aviate.killbill.io[Aviate Catalog UI] allows you to create individual catalog entries such as products, plans, and pricelists.

Uh oh!

Conversation

reshmabidikar commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

reshmabidikar commented Jan 29, 2026 •

edited

Loading