You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: app/_how-tos/get-started-with-metering-and-billing.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Get started with Metering and Billing in {{site.konnect_short_name}}
2
+
title: Get started with {{site.metering_and_billing}} in {{site.konnect_short_name}}
3
3
description: Learn how to...
4
4
content_type: how_to
5
5
@@ -18,11 +18,11 @@ tags:
18
18
- get-started
19
19
20
20
tldr:
21
-
q: What is Metering and Billing in {{site.konnect_short_name}}, and how can I get started with it?
21
+
q: What is {{site.metering_and_billing}} in {{site.konnect_short_name}}, and how can I get started with it?
22
22
a: |
23
-
[Metering & Billing](/metering-and-billing/) provides flexible billing and metering for AI and DevTool companies. It also includes real-time insights and usage limit enforcement.
23
+
[{{site.metering_and_billing}}](/metering-and-billing/) provides flexible billing and metering for AI and DevTool companies. It also includes real-time insights and usage limit enforcement.
24
24
25
-
This tutorial will help you get started with Metering & Billing by setting up metering based on {{site.base_gateway}} API requests, turn raw API usage into billable product offerings by defining features and pricing plans, and start subscriptions to assign to customers.
25
+
This tutorial will help you get started with {{site.metering_and_billing}} by setting up metering based on {{site.base_gateway}} API requests, turn raw API usage into billable product offerings by defining features and pricing plans, and start subscriptions to assign to customers.
26
26
27
27
tools:
28
28
- deck
@@ -36,7 +36,7 @@ prereqs:
36
36
inline:
37
37
- title: "{{site.konnect_short_name}} roles"
38
38
content: |
39
-
You need the [? role](/konnect-platform/teams-and-roles/#service-catalog) in {{site.konnect_short_name}} to configure metering and billing.
39
+
You need the [? role](/konnect-platform/teams-and-roles/#service-catalog) in {{site.konnect_short_name}} to configure {{site.metering_and_billing}}.
40
40
icon_url: /assets/icons/kogo-white.svg
41
41
42
42
cleanup:
@@ -59,7 +59,7 @@ next_steps:
59
59
automated_tests: false
60
60
---
61
61
62
-
This getting-started guide shows how you can meter {{site.base_gateway}} API requests and invoice your customers based on their API consumption with Metering & Billing in {{site.konnect_short_name}}.
62
+
This getting-started guide shows how you can meter {{site.base_gateway}} API requests and invoice your customers based on their API consumption with {{site.metering_and_billing}} in {{site.konnect_short_name}}.
63
63
64
64
In this guide, you'll:
65
65
* Create a {{site.base_gateway}} Consumer that you'll map as a customer
@@ -68,7 +68,7 @@ In this guide, you'll:
68
68
* Start subscriptions for a customer
69
69
* Generate an invoice for a customer on the paid premium plan and see their API usage
70
70
71
-
The following diagram shows how {{site.base_gateway}} entities and Metering & Billing entities are associated:
71
+
The following diagram shows how {{site.base_gateway}} entities and {{site.metering_and_billing}} entities are associated:
Before you configure metering and billing, you can set up a Consumer, Kong Air. [Consumers](/gateway/entities/consumer/) let you identify the client that's interacting with {{site.base_gateway}}. Later in this guide, you'll be mapping this Consumer to a customer in Metering & Billing and assigning them to a Premium plan. Doing this allows you map existing Consumers that are already consuming your APIs to customers to make them billable.
105
+
Before you configure {{site.metering_and_billing}}, you can set up a Consumer, Kong Air. [Consumers](/gateway/entities/consumer/) let you identify the client that's interacting with {{site.base_gateway}}. Later in this guide, you'll be mapping this Consumer to a customer in {{site.metering_and_billing}} and assigning them to a Premium plan. Doing this allows you map existing Consumers that are already consuming your APIs to customers to make them billable.
106
106
107
107
You're going to use key [authentication](/gateway/authentication/) in this tutorial, so the Consumer needs an API key to access any {{site.base_gateway}} Services.
108
108
@@ -136,11 +136,11 @@ entities:
136
136
137
137
## Create a meter
138
138
139
-
In Metering & Billing, meters track and record the consumption of a resource or service over time. This usage can take various forms, such as API requests, compute time seconds, or tokens consumed. Usage metering is commonly event-based to ensure accuracy and data you can audit.
139
+
In {{site.metering_and_billing}}, meters track and record the consumption of a resource or service over time. This usage can take various forms, such as API requests, compute time seconds, or tokens consumed. Usage metering is commonly event-based to ensure accuracy and data you can audit.
140
140
141
-
In this guide, you'll enable API Gateway requests for metering. This will meter API request traffic in Metering & Billing so that you can charge customers for API traffic usage.
141
+
In this guide, you'll enable API Gateway requests for metering. This will meter API request traffic in {{site.metering_and_billing}} so that you can charge customers for API traffic usage.
142
142
143
-
1. In the {{site.konnect_short_name}} sidebar, click **Metering & Billing**.
143
+
1. In the {{site.konnect_short_name}} sidebar, click **{{site.metering_and_billing}}**.
144
144
1. Enable **API Gateway Requests**.
145
145
146
146
## Create a feature
@@ -151,8 +151,8 @@ Features are customer-facing, and show up on the invoice for paid plans. Feature
151
151
152
152
In this guide, you'll create a feature for the `example-service` you created in the prerequisites.
153
153
154
-
1. In the {{site.konnect_short_name}} sidebar, click **Metering & Billing**.
155
-
1. In the Metering & Billing sidebar, click **Product Catalog**.
154
+
1. In the {{site.konnect_short_name}} sidebar, click **{{site.metering_and_billing}}**.
155
+
1. In the {{site.metering_and_billing}} sidebar, click **Product Catalog**.
156
156
1. Click **Create Feature**.
157
157
1. In the **Name** field, enter `example-service`.
158
158
1. From the **Meter** dropdown menu, select "kong_konnect_api_request".
@@ -171,8 +171,8 @@ A rate card describes price and usage limits or access control for a feature or
171
171
172
172
In this section, you'll create a Premium plan that grants paying customers access to the `example-service` at a rate of 5,000 requests per month:
173
173
174
-
1. In the {{site.konnect_short_name}} sidebar, click **Metering & Billing**.
175
-
1. In the Metering & Billing sidebar, click **Product Catalog**.
174
+
1. In the {{site.konnect_short_name}} sidebar, click **{{site.metering_and_billing}}**.
175
+
1. In the {{site.metering_and_billing}} sidebar, click **Product Catalog**.
176
176
1. Click the **Plans** tab.
177
177
1. Click **Create Plan**.
178
178
1. In the **Name** field, enter `Premium`.
@@ -192,8 +192,8 @@ In this section, you'll create a Premium plan that grants paying customers acces
192
192
193
193
Customers are the entities who pay for the consumption. In many cases, it's equal to your Consumer. Here you are going to create a customer and map our Consumer to it.
194
194
195
-
1. In the {{site.konnect_short_name}} sidebar, click **Metering & Billing**.
196
-
1. In the Metering & Billing sidebar, click **Billing**.
195
+
1. In the {{site.konnect_short_name}} sidebar, click **{{site.metering_and_billing}}**.
196
+
1. In the {{site.metering_and_billing}} sidebar, click **Billing**.
197
197
1. Click **Create Customer**.
198
198
1. In the **Name** field, enter `Kong Air`.
199
199
1. In the **Include usage from** dropdown, select "kong-air".
@@ -219,13 +219,13 @@ headers:
219
219
{% endvalidation %}
220
220
<!--vale on-->
221
221
222
-
This will generate six requests. Now, check the invoice that was created in Metering & Billing:
222
+
This will generate six requests. Now, check the invoice that was created in {{site.metering_and_billing}}:
223
223
224
-
1. In the {{site.konnect_short_name}} sidebar, click **Metering & Billing**.
225
-
1. In the Metering & Billing sidebar, click **Billing**.
224
+
1. In the {{site.konnect_short_name}} sidebar, click **{{site.metering_and_billing}}**.
225
+
1. In the {{site.metering_and_billing}} sidebar, click **Billing**.
226
226
1. Click the **Invoices** tab.
227
227
1. Click **Kong Air**.
228
228
1. Click the **Invoicing** tab.
229
229
1. Click **Preview Invoice**.
230
230
231
-
You'll see in Lines that `example-service` is listed and was used six times. In this guide, you're using the sandbox for invoices. To deploy your subscription in production, configure a payments integration in **Metering & Billing** > **Settings**.
231
+
You'll see in Lines that `example-service` is listed and was used six times. In this guide, you're using the sandbox for invoices. To deploy your subscription in production, configure a payments integration in **{{site.metering_and_billing}}** > **Settings**.
Copy file name to clipboardExpand all lines: app/_landing_pages/metering-and-billing.yaml
+21-21Lines changed: 21 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
metadata:
2
-
title: "Metering and Billing"
2
+
title: "{{site.metering_and_billing}}"
3
3
content_type: landing_page
4
-
description: Learn how to meter and bill for your features with Metering and Billing.
4
+
description: Learn how to meter and bill for your features with {{site.metering_and_billing}}.
5
5
breadcrumbs:
6
6
- /metering-and-billing/
7
7
products:
@@ -10,7 +10,7 @@ metadata:
10
10
rows:
11
11
- header:
12
12
type: h1
13
-
text: "Metering and Billing"
13
+
text: "{{site.metering_and_billing}}"
14
14
sub_text: Meter, bill, and monetize the entire AI connectivity data path.
15
15
columns:
16
16
- blocks:
@@ -19,7 +19,7 @@ rows:
19
19
blocks:
20
20
- type: text
21
21
text: |
22
-
{{site.konnect_short_name}} Metering & Billing provides a full system for tracking real-time usage, pricing products, enforcing entitlements, and generating invoices.
22
+
{{site.konnect_short_name}} {{site.metering_and_billing}} provides a full system for tracking real-time usage, pricing products, enforcing entitlements, and generating invoices.
23
23
It is designed for AI and API-first businesses that need accurate usage metering, flexible pricing models, and customer-level billing detail.
24
24
25
25
You can meter {{site.base_gateway}} requests, LLM tokens, or any custom event.
Track prompt tokens, completion tokens, and model usage from {{site.base_gateway}} or any AI gateway backed by Konnect.
46
-
icon: /assets/icons/ai.svg
45
+
{{site.konnect_short_name}} {{site.metering_and_billing}}’s Product Catalog lets you centrally define the different plans and plan features that make up your offering—so you can manage pricing, entitlements, and packaging in one place.
46
+
icon: /assets/icons/document.svg
47
47
cta:
48
-
text: Learn how
49
-
url: /metering-and-billing/monitor-llm-traffic/
48
+
text: Learn more
49
+
url: /metering-and-billing/product-catalog/
50
50
- blocks:
51
51
- type: card
52
52
config:
53
-
title: Meter {{site.base_gateway}} API requests
53
+
title: Customers and usage attribution
54
54
description: |
55
-
Convert raw API request events into billable usage. Create meters, features, pricing, and subscriptions.
56
-
icon: /assets/icons/gateway.svg
55
+
Customers represent individuals or organizations that subscribe to plans, gain access to features, and are invoiced for their consumption.
56
+
icon: /assets/icons/team.svg
57
57
cta:
58
-
text: Get started
59
-
url: /metering-and-billing/get-started/
58
+
text: Learn more
59
+
url: /metering-and-billing/customer/
60
60
- blocks:
61
61
- type: card
62
62
config:
63
-
title: Understand customers
63
+
title: Billing, invoicing, and subscriptions
64
64
description: |
65
-
Learn how {{site.konnect_short_name}} models customers and usage mapping for billing systems.
66
-
icon: /assets/icons/team.svg
65
+
Learn how to set up billing, invoicing, and subscriptions in {{site.konnect_short_name}} {{site.metering_and_billing}}.
@@ -24,7 +24,7 @@ Each {{site.metering_and_billing}} instance has one default billing profile that
24
24
25
25
A billing profile is linked to a specific App. This association is established during the billing profile's creation and remains immutable. When transitioning to a new app, organizations must [migrate to a new billing profile](#customer-billing-profile-overrides).
26
26
27
-
Billing profiles can be managed from the [**Billing Profiles**](https://cloud.konghq.com/metering-billing/billing-profiles) tab in **Metering & Billing > Settings** in the {{site.konnect_short_name}} UI.
27
+
Billing profiles can be managed from the [**Billing Profiles**](https://cloud.konghq.com/metering-billing/billing-profiles) tab in **{{site.metering_and_billing}} > Settings** in the {{site.konnect_short_name}} UI.
28
28
29
29
### Invoicing settings
30
30
@@ -64,7 +64,7 @@ Customer overrides can be useful for the following use cases:
64
64
***Enterprise billing**: Set up one billing profile for SaaS customers and another for Enterprise customers (with send invoice for bank transfer selected).
65
65
***Migrating customers billing**: Create a new billing profile that you want to migrate customers to and then assign them to the new profile with a customer override.
66
66
67
-
Configure customer overrides by navigating to **Metering & Billing** > [**Billing**](https://cloud.konghq.com/metering-billing/customers), click a customer, then navigate to the **Billing Profile** section of the customer settings.
67
+
Configure customer overrides by navigating to **{{site.metering_and_billing}}** > [**Billing**](https://cloud.konghq.com/metering-billing/customers), click a customer, then navigate to the **Billing Profile** section of the customer settings.
68
68
69
69
## Tax calculations
70
70
@@ -84,7 +84,7 @@ The invoice document maintains comprehensive and structured information that is
84
84
* The total amount of taxes
85
85
* The total amount after taxes and discounts charged to the customer
86
86
87
-
To view invoices in {{site.konnect_short_name}}, navigate to **Metering & Billing** > **Billing** and click the **Invoices** tab.
87
+
To view invoices in {{site.konnect_short_name}}, navigate to **{{site.metering_and_billing}}** > **Billing** and click the **Invoices** tab.
88
88
89
89
### Invoice lifecycle
90
90
@@ -155,7 +155,7 @@ Subscriptions automate the billing lifecycle by:
155
155
156
156
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.
157
157
158
-
To add a subscription to a customer, navigate to **Metering & Billing** > **Billing**, click your customer, and then click the **Subscriptions** tab in the {{site.konnect_short_name}} UI.
158
+
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.
0 commit comments