Skip to content

Commit 3924ad2

Browse files
reshmabidikarreshmabidikar
committed
Getting Started - First Draft
1 parent a5cb119 commit 3924ad2

File tree

3 files changed

+252
-0
lines changed

3 files changed

+252
-0
lines changed

‎html5/_main_toc.html.slim‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,9 @@ nav.sidebar-nav
353353
li.bd-sidenav-active
354354
a.nav-link href="/latest/aviate-changelog.html"
355355
| Aviate Changelog
356+
li.bd-sidenav-active
357+
a.nav-link href="/latest/aviate-getting-started.html"
358+
| Getting Started With Aviate
356359
li.bd-sidenav-active
357360
a.nav-link href="/latest/aviate-catalog-guide.html"
358361
| Aviate Catalog Guide

‎userguide/assets/img/aviate/cloudsprout-plans-products.png‎

59.6 KB
Loading

‎userguide/aviate/aviate_getting_started.adoc‎

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
= Getting Started with Aviate and Kaui
2+
3+
== TL;DR
4+
5+
In this guide, you will:
6+
7+
* Use *Aviate* to configure your billing environment.
8+
* Switch to *Kaui* to create your first customer and subscription.
9+
* Generate and view an invoice.
10+
* Understand the role of *Kill Bill*, *Aviate*, and *Kaui*.
11+
* End up with a fully working fictive SaaS company set up for demos.
12+
13+
The example company used throughout this guide is *CloudSprout*, a fictional SaaS business operating in the UK and France.
14+
15+
---
16+
17+
== Concepts Overview
18+
19+
Before starting, it helps to understand how the pieces fit together.
20+
21+
* *Kill Bill* is the billing engine. It manages accounts, subscriptions, invoices, payments, and taxes.
22+
* *Aviate* is the Enterprise control and management plane. You use it to configure catalogs, taxes, invoice templates, and tenant settings, as well as proactively monitor the health of the billing engine.
23+
* *Kaui* is the billing operations UI. You use it for day-to-day actions such as creating customers, managing subscriptions, and reviewing invoices.
24+
25+
In short:
26+
27+
* Use *Aviate* to *set things up*.
28+
* Use *Kaui* to *run billing operations*.
29+
30+
---
31+
32+
== Step 1: Start in Aviate (Get Started)
33+
34+
When you first log into Aviate, you land on the *Get Started* screen.
35+
36+
This checklist guides you through the minimum required setup to bill customers.
37+
38+
You should complete all steps in order.
39+
40+
=== Configure company settings
41+
42+
This step defines who you are as a business.
43+
44+
For the purpose of this guide, use the following fictive company:
45+
46+
* Company name: *CloudSprout*
47+
* Business type: B2B SaaS
48+
* Operating countries:
49+
** United Kingdom (GBP)
50+
** France (EUR)
51+
52+
This information is later reused on invoices and customer communications.
53+
54+
The following demo shows how you can configure the company settings via Aviate.
55+
++++
56+
<div>
57+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
58+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
59+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/eykmjqwtc4vf?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>
60+
</div>
61+
</div>
62+
++++
63+
64+
---
65+
66+
=== Configure the catalog
67+
68+
The catalog defines what you sell.
69+
70+
For CloudSprout, create a simple catalog with:
71+
72+
* A small number of subscription plans (for example Starter, Team, Business).
73+
* Optional add-ons (for example Extra Storage).
74+
75+
| Plan | GBP | EUR | Notes |
76+
| ----------- | ----------- | ----------- | ----------------- |
77+
| 🌱 Starter | £9 / month | €10 / month | Monthly only |
78+
| 🌿 Team | £29 / month | €32 / month | Monthly or annual |
79+
| 🌳 Business | £79 / month | €89 / month | Annual only |
80+
81+
| Add-on | GBP | EUR | Billing |
82+
| ---------------- | --- | --- | ------- |
83+
| Extra Storage | £5 | €6 | Monthly |
84+
| Priority Support | £15 | €18 | Monthly |
85+
86+
The following demo shows how you can create the `CloudSprout Starter` plan via Aviate.
87+
++++
88+
<div>
89+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
90+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
91+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/ndzb6bp2lxvp?embed=inline" 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>
92+
</div>
93+
</div>
94+
++++
95+
96+
You can similarly create the other plans/products defined above:
97+
98+
image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/aviate/cloudsprout-plans-products.png[align=center]
99+
100+
This step only defines products and plans. No customers are created yet.
101+
102+
---
103+
104+
=== Configure taxes
105+
106+
Taxes are configured in Aviate and applied automatically by Kill Bill.
107+
108+
For the demo setup:
109+
110+
* Create a tax code for the UK (VAT) with a 20% rate.
111+
* Create a tax code for France (VAT) with a 20% rate.
112+
* Set a valid start date.
113+
114+
Once saved, tax codes can be associated with products.
115+
116+
The following demo explains how you can configure the above tax codes:
117+
118+
++++
119+
<div>
120+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
121+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
122+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/babn3wd83xaf?embed=inline" 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>
123+
</div>
124+
</div>
125+
++++
126+
127+
---
128+
129+
== Step 2: Switch to Kaui (Billing Operations)
130+
131+
After completing the Aviate checklist, the next steps happen in Kaui.
132+
133+
From Aviate, use the *Billing Operations (Kaui)* links to open Kaui in a new tab.
134+
135+
The following demo illustrates how you can switch to Kaui:
136+
++++
137+
<div>
138+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
139+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
140+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/zb3tar3rqv1s?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>
141+
</div>
142+
</div>
143+
++++
144+
145+
---
146+
147+
=== Create your first customer
148+
149+
In Kaui:
150+
151+
. Navigate to *Accounts*.
152+
. Create a new account.
153+
. Select the appropriate currency (EUR or GBP).
154+
. Save the account.
155+
156+
---
157+
158+
The following demo illustrates the account creation process in Kaui:
159+
160+
161+
++++
162+
<div>
163+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
164+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
165+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/k4gk7pp5fmjb?embed=inline" 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>
166+
</div>
167+
</div>
168+
++++
169+
170+
At this point, you have a customer but no billing activity yet.
171+
172+
=== Create a subscription
173+
174+
Next, attach a subscription to the customer.
175+
176+
. Open the customer account.
177+
. Create a new subscription.
178+
. Select one of the catalog plans you created in Aviate.
179+
. Optionally add an add-on.
180+
. Confirm the start date.
181+
182+
Kill Bill immediately generates billing events based on the catalog rules.
183+
184+
The following demo guides you through the subscription creation process in Kaui:
185+
186+
++++
187+
<div>
188+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
189+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
190+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/zctynkd1ayr0?embed=inline" 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>
191+
</div>
192+
</div>
193+
++++
194+
195+
---
196+
197+
=== View the invoice
198+
199+
Once the subscription is active:
200+
201+
. Navigate to *Invoices* in Kaui.
202+
. Open the newly generated invoice.
203+
. Review:
204+
205+
* Currency
206+
* Line items
207+
* Tax calculation
208+
* Total amount
209+
210+
This invoice uses the configuration, colors, and the logo defined earlier in Aviate.
211+
212+
The following demo illustrates verifying the generated invoice:
213+
++++
214+
<div>
215+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
216+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
217+
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/7t2szcxpfr27?embed=inline" 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>
218+
</div>
219+
</div>
220+
++++
221+
222+
---
223+
224+
== What You Have Achieved
225+
226+
By following this guide, you have:
227+
228+
* Configured a complete billing environment using *Aviate*.
229+
* Created a customer and subscription using *Kaui*.
230+
* Generated a real invoice powered by *Kill Bill*.
231+
* Understood the separation of concerns between:
232+
** *Kill Bill* (engine)
233+
** *Aviate* (configuration)
234+
** *Kaui* (operations)
235+
236+
You now have a fully working fictive SaaS company ready for demos or experimentation.
237+
238+
---
239+
240+
== Next Steps
241+
242+
From here, you can:
243+
244+
* Add more products or plans.
245+
* Experiment with upgrades, downgrades, and add-ons.
246+
* Explore payments and refunds.
247+
* Integrate Kill Bill APIs into your own application.
248+
249+
This same flow applies to production environments. Only the data changes.

0 commit comments

Comments
 (0)