Introduction

The Aviate Catalog UI allows you to create individual catalog entries such as products, plans, and pricelists. 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. Internally, the UI uses the Aviate Catalog APIs.

Create Product,Plan, Pricelist

To create a product, plan, and pricelist:

  1. Open the Create Product, Plan, Pricelist screen.

  2. Enter the product name (e.g., netflix).

  3. Define a plan (e.g., netflix-basic-monthly).

  4. Set the price (e.g., $10 per month).

  5. Save your entries.

Demo:

API Used: Create Plan, Product, Pricelist API.

Add New Plan

Once a product exists, you can add additional plans:

  1. Select the product (e.g., netflix).

  2. Create a new plan (e.g., netflix-premium-monthly).

  3. Configure phases such as DISCOUNT or EVERGREEN.

  4. Save the plan.

Demo:

API used: Create Plan API.

Edit Plan

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.

Note
 Editing a plan creates a new version of the plan. Existing subscriptions continue to use the old plan. See docs.

  1. Select the plan (e.g., netflix-basic-monthly).

  2. Adjust the price.

  3. Save changes.

Demo:

API used: Modify Plan API.

Archive Plan

You can archive an existing plan. Archiving prevents creating new subscriptions corresponding to the plan. The plan remains active for existing subscriptions.

  1. Select the plan (e.g., Netflix Usage Monthly).

  2. Choose Archive.

  3. Confirm the action.

Demo:

API used: Retire Plan API.

Delete Plan

You can delete an existing plan permanently. Deleting permanently removes a plan from the database.

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.

  1. Select the plan.

  2. Choose Delete.

  3. Confirm deletion.

API used: Delete Plan API.

Duplicate Plan

You can create a new plan based on an existing plan.

Note
 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. By contrast, the Edit Plan feature is limited to updating prices only, and each change automatically generates a new version of the plan.

  1. Select the plan

  2. Choose Duplicate

  3. Make changes to the plan as desired

  4. Save the new plan.

Demo:

Creating Usage Plans

Usage plans allow billing based on consumption. See docs.

  1. Define a billing meter (how usage is tracked).

  2. Configure blocks/tiers.

  3. Assign usage-based prices to each block.

  4. Save the plan.

Demo:

API used: Create Plan API.

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