Skip to content

Commit 75620ee

Browse files
feat(M&B): Migrate add-ons (#4887)
* migrate add-ons doc * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * link to rate cards --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 7ac1fdf commit 75620ee

4 files changed

Lines changed: 101 additions & 2 deletions

File tree

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: "Add-ons"
3+
content_type: reference
4+
description: "Plan add-ons let you sell extra features, overage packs, or services without changing the core plan."
5+
layout: reference
6+
products:
7+
- metering-and-billing
8+
works_on:
9+
- konnect
10+
breadcrumbs:
11+
- /metering-and-billing/
12+
- /metering-and-billing/product-catalog/
13+
related_resources:
14+
- text: "{{site.konnect_short_name}} {{site.metering_and_billing}}"
15+
url: /metering-and-billing/
16+
- text: "Rate cards"
17+
url: /metering-and-billing/product-catalog/#rate-cards
18+
---
19+
20+
Add-ons let you sell extra features, overage packs, or services without changing the core plan.
21+
Use them to:
22+
* Enable features not included in the base plan.
23+
* Extend usage limits for existing features.
24+
* Cross-sell or bundle products by adding new rate cards and prices.
25+
26+
## How add-ons work
27+
28+
An add-on is made up of one or more [rate cards](/metering-and-billing/product-catalog/#rate-cards), each defining a specific feature, its pricing, billing cadence, and entitlements.
29+
30+
This modular structure lets you mix and match features and capacities independently of your base plans.
31+
32+
Add-ons can be:
33+
* Single-instance: Only one instance of this add-on allowed per subscription.
34+
* Multi-instance: Multiple instances of this add-on allowed per subscription.
35+
36+
## Managing add-ons for plans
37+
38+
Add-ons can be configured for compatible plans.
39+
Compatibility is managed through the plan versioning cycle:
40+
41+
* **Draft Version**: You can freely add or remove add-ons to a plan before publishing.
42+
* **Published Version**: Once a plan is published, the set of add-ons is locked and available to new subscriptions.
43+
44+
When assigning an add-on to a plan, you choose how many instances are allowed per subscription and at which phase of the plan the add-on is available.
45+
46+
{{site.metering_and_billing}} has a few limitations on add-on and plan compatibility:
47+
48+
* The billing cadences of the add-on must match the plan's billing cadence.
49+
* Any rate cards present in both the add-on and the plan must meet extendability rules.
50+
51+
{:.warning}
52+
> Once a plan version is published, the add-ons assigned to that plan **cannot** be changed.
53+
If you need to add add-ons to a published plan, create a new version of that plan.
54+
55+
### Apply an add-on to a plan
56+
57+
To create a new add-on, go to **Metering & Billing** > **Product Catalog** > **Add-ons** tab.
58+
59+
To apply an existing add-on to a plan, go to **{{site.metering_and_billing}}** > **Product Catalog** > **Plans** tab, and choose a plan that's in draft status.
60+
61+
## Purchasing add-ons
62+
63+
You can purchase add-ons for an active subscription as long as they're compatible with the subscription's underlying plan.
64+
Add-ons can't be purchased for custom subscriptions.
65+
66+
When an add-on is purchased, its contents are merged into the subscription's existing items:
67+
* If the add-on's rate card isn't already in the subscription, it's added as a new item.
68+
* If the rate card already exists in the subscription, the existing item is extended with the add-on's rate card contents.
69+
70+
The resulting items keep the subscription's alignment and billing cadence.
71+
72+
{:.warning}
73+
> Once a subscription has add-ons, you can no longer edit the subscription directly.
74+
At that point, you can only add or remove add-ons.
75+
If you need to change the subscription, cancel the subscription and create a new one.
76+
77+
### Apply an add-on to a subscription
78+
79+
If a customer is on a plan with add-ons available, you can apply add-ons to that customer's subscription.
80+
81+
To apply an add-on to an active subscription, go to **{{site.metering_and_billing}}** > **Billing** > **Customers** > select a customer > **Subscriptions** tab > **Apply Add-on**.
82+
83+
## Extendability
84+
85+
When an add-on extends an existing subscription, properties are merged as follows:
86+
87+
* Static prices are summed.
88+
* Boolean entitlements are merged into a single boolean entitlement.
89+
* Metered entitlements are merged by summing their allowance for the billing period if all other properties match.
90+
* Usage discounts are concatenated as a list.
91+
92+
Any combination not listed above is either non-effectual or will cause a validation error during compatibility checks.
93+
In general, we recommend splitting an add-on's contents across multiple rate cards.
94+

app/metering-and-billing/billing-invoicing-subscriptions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,8 @@ Subscriptions follow a billing cycle determined by their related [rate card](/me
294294

295295
To add a subscription to a customer, navigate to **{{site.metering_and_billing}}** > **Billing**, click your customer, and then click the **Subscriptions** tab in the {{site.konnect_short_name}} UI.
296296

297+
Active customer subscriptions can be enhanced with [add-ons](/metering-and-billing/add-ons/), which allow you to make changes to a customer's entitlements without changing the plan directly.
298+
297299
## Plan migration
298300

299301
Plans in {{site.metering_and_billing}} are versioned. When you update a plan, existing subscriptions remain on their current version. This is known as "grandfathering". Customers keep their existing pricing until they're explicitly migrated.

app/metering-and-billing/entitlements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ breadcrumbs:
1515
related_resources:
1616
- text: "{{site.konnect_short_name}} {{site.metering_and_billing}}"
1717
url: /metering-and-billing/
18-
- text: "Rate Cards"
18+
- text: "Rate cards"
1919
url: /metering-and-billing/product-catalog/#rate-cards
2020

2121
---

app/metering-and-billing/product-catalog.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,10 @@ Rate cards can be configured with or without a feature:
255255

256256
#### Add-ons
257257

258-
Add-ons let you extend your plans with optional features or capacity that customers can purchase on demand. They are versioned and consist of one or more rate cards defining pricing, entitlements, and billing cadence independently of the base plan. Add-ons allow you to sell extra features, overage packs, or services without changing the core plan.
258+
Add-ons let you extend your plans with optional features or capacity that customers can purchase on demand.
259+
They are versioned and consist of one or more rate cards defining pricing, entitlements, and billing cadence independently of the base plan.
260+
261+
See the [Add-ons reference](/metering-and-billing/add-ons/) to learn more.
259262

260263
#### Pricing models
261264

0 commit comments

Comments
 (0)