Skip to content

Commit a832b6d

Browse files
Guariscloudjumpercat
authored andcommitted
billing and subs
1 parent 9f160ba commit a832b6d

File tree

1 file changed

+133
-0
lines changed

1 file changed

+133
-0
lines changed
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
title: "Billing and Subscriptions"
3+
content_type: reference
4+
description: "Learn how billing and subscriptions work in {{site.konnect_short_name}} {{site.metering_and_billing}}."
5+
layout: reference
6+
products:
7+
- metering-and-billing
8+
tools:
9+
- konnect-api
10+
works_on:
11+
- konnect
12+
breadcrumbs:
13+
- /metering-and-billing/
14+
related_resources:
15+
- text: "{{site.konnect_short_name}} Metering and Billing"
16+
url: /metering-and-billing/
17+
18+
---
19+
20+
21+
## Overview
22+
23+
Billing and subscriptions in {{site.metering_and_billing}} create relationships between customers and their pricing model. This serves as the bridge between your customers, their usage data, and how that usage translates into billable amounts.
24+
25+
<!--vale off-->
26+
{% mermaid %}
27+
flowchart TD
28+
29+
customer[Customer]
30+
31+
customer --> entitlements
32+
customer --> subscriptions
33+
customer --> invoices
34+
35+
entitlements --> feature1
36+
entitlements --> feature2
37+
entitlements -.-> feature3
38+
39+
feature1[Feature 1]
40+
feature2[Feature 2]
41+
feature3[Feature 3]
42+
43+
subscriptions[Subscriptions]
44+
invoices[Invoices]
45+
entitlements[Entitlements]
46+
47+
{% endmermaid %}
48+
<!--vale on-->
49+
50+
51+
## How subscriptions work
52+
53+
Subscriptions automate the billing lifecycle by:
54+
55+
* **Tracking usage** through meters
56+
* **Applying pricing logic** from plans or custom configurations
57+
* **Generating invoices** based on billing cadences
58+
* **Enforcing entitlements** to control feature access
59+
60+
Subscriptions can be created from predefined plans or fully customized at creation time to accommodate unique customer requirements. This flexibility supports everything from self-serve sign-ups to enterprise contract negotiations.
61+
62+
## Subscription structure
63+
64+
Plans and subscriptions share a similar structure, but where plans use templates, subscriptions contain concrete, instantiated values with actual timestamps and configurations.
65+
66+
## Billing
67+
68+
Billing in {{site.konnect_short_name}} allows you to manage Customers, Entitlements, and Invoices.
69+
70+
### Customers
71+
72+
Customer records form the foundation of your billing relationships. Each customer requires specific information to enable accurate billing and usage tracking.
73+
74+
{% table %}
75+
columns:
76+
- title: Field
77+
key: field
78+
- title: Description
79+
key: description
80+
rows:
81+
- field: Name (required)
82+
description: The customer's display name for identification purposes
83+
- field: Key (optional)
84+
description: A unique identifier for this customer, useful when integrating with external systems
85+
{% endtable %}
86+
87+
88+
Usage attribution defines how events are linked to customers. {{site.metering_and_billing}} supports multiple attribution methods:
89+
90+
{% table %}
91+
columns:
92+
- title: Attribution method
93+
key: method
94+
- title: Description
95+
key: description
96+
rows:
97+
- method: Consumers
98+
description: Used by API and AI gateways to track usage
99+
- method: Applications
100+
description: Used by developer portals to attribute usage to specific applications
101+
- method: Subjects
102+
description: Used for generic metering scenarios where events are tagged with custom identifiers
103+
{% endtable %}
104+
105+
You can select one or more attribution methods. Events are automatically attributed to the customer when the event's subject property matches one of the selected values. Multiple attribution methods can be enabled simultaneously to support diverse usage tracking scenarios within a single customer account.
106+
107+
Once created, customers can be:
108+
109+
* Assigned to subscription plans
110+
* Monitored for usage patterns
111+
* Invoiced based on their subscription configuration
112+
* Updated with new billing information as needed
113+
114+
## Plan migration
115+
116+
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.
117+
118+
Migrating a subscription to a new plan version allows you to:
119+
120+
* Apply new pricing to existing customers
121+
* Transition customers to improved plan structures
122+
* Deprecate old plan versions
123+
* Standardize customers on current offerings
124+
125+
## Migration Timing
126+
127+
Migrations follow the same timing rules as other subscription changes:
128+
129+
* **Immediate**: Migration takes effect right away
130+
* **Next billing cycle**: Migration occurs at the end of the current period
131+
132+
Choose timing based on whether the migration is favorable (immediate) or potentially disruptive (next cycle) to the customer.
133+

0 commit comments

Comments
 (0)