Skip to content

Feat: Metering and Billing customer entity#3540

Merged
cloudjumpercat merged 7 commits intorelease/konnect-metering-and-billingfrom
metering-customer
Dec 11, 2025
Merged

Feat: Metering and Billing customer entity#3540
cloudjumpercat merged 7 commits intorelease/konnect-metering-and-billingfrom
metering-customer

Conversation

@Guaris
Copy link
Contributor

@Guaris Guaris commented Nov 24, 2025

Description

Fixes #3342

Preview Links

https://deploy-preview-3540--kongdeveloper.netlify.app/metering-and-billing/customer/

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@Guaris Guaris requested a review from a team as a code owner November 24, 2025 22:28
@netlify
Copy link

netlify bot commented Nov 24, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 286eb1b
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6939e6705ef52b0008e022dd
😎 Deploy Preview https://deploy-preview-3540--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my review:

  • I completely reworked customers to include info about subjects/usage attributes
  • Recommend deleting the subjects and assigned subjects include as they are part of the customer page now

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can delete this file as I've added all the relevant info from this to the Customers page.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can delete this file as I've added all the relevant info from this to the Customers page.

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
---
title: "Customers and usage attributes"
content_type: reference
description: "Learn how Customers and usage attributes work in {{site.konnect_short_name}} Metering and Billing and how they access features."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Metering & Billing

@@ -0,0 +1,190 @@
---
title: "Customers and usage attributes"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Customers and usage attribution


Customers represent individuals or organizations that subscribe to plans and gain access to features.

Billable events ingested into OpenMeter always include a usage attribute.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Billable events ingested into Metering & Billing always include a subject field that represents metered entities within your system, such as {{site.base_gateway}} Consumers, Dev Portal applications, or entities outside of {{site.konnect_short_name}}).

key: recommendation
rows:
- use-case: |
Attribute AI token usage to customers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Attribute Kong AI Gateway token usage to customers.

Attribute AI token usage to customers.
recommendation: "[Consumers](/gateway/entities/consumer/)"
- use-case: |
Attribute API request usage to customers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Attribute Kong API Gateway requests to customers.

Attribute API request usage to customers.
recommendation: "[Consumers](/gateway/entities/consumer/)"
- use-case: |
Attribute Dev Portal application usage to customers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Attribute Kong Developer Portal application requests to customers.


### What is a subject?

Subjects represent the entity that consumes metered resources in {{site.konnect_short_name}} Metering and Billing. Billable events ingested to Metering and Billing have a subject associated with them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Metering & Billing

Comment on lines +87 to +96
Each subject contains the following fields:

* **Key** – The subject’s unique identifier
* **Display name** – A human-readable label shown in the UI
* **Metadata** – Optional key-value attributes for additional context

{:.info}
> We recommend creating a subject when a new customer or user is created in your system and deleting a subject when a customer or user is deleted. Keeping the subjects in sync in Metering and Billing is necessary if you synchronize usage to external systems, such as Stripe billing or CRMs, as {{site.konnect_short_name}} knows the mapping between the subject and the external system.
> {{site.konnect_short_name}} Metering and Billing will also automatically create a subject for you when you ingest an usage event for a new subject.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete, there is no subject entity anymore. It's just a key on event.

1. Click **Create Customer**.
1. In the **Name** field, enter your customer's name.
1. Select **Applications**.
1. In the **Include usage from** dropdown, search for the Dev Portal application.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we call it Dev Portal or Developer Portal?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hekike It's Dev Portal

@cloudjumpercat cloudjumpercat merged commit 6b22143 into release/konnect-metering-and-billing Dec 11, 2025
12 checks passed
@cloudjumpercat cloudjumpercat deleted the metering-customer branch December 11, 2025 15:07
Guaris added a commit that referenced this pull request Dec 17, 2025
* Feat: Konnect metering and billing Subjects (#3478)

* subjects

* add schema

* Apply suggestions from code review

* appease vale

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* add metering and billing var

* Feat: Metering and Billing customer entity (#3540)

* subjects

* add schema

* metering customer

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

* Delete two subject pages as I moved the content to the customers page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Feat(Metering and Billing): Product Catalog (#3561)

* product catalog

* Discounts, Product Catalog and an include

* rework product catalog page

* appease vale

* Apply suggestions from code review

* fix broken link

---------

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Feat(Metering&Billing): Metering landing page (#3617)

* landing page

* fix urls

* icons

* Apply suggestions from code review

* Fix images and svgs

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat(metering): Get Started guide (#3504)

* Start outlining the get started guide

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Finish the rough draft

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add M&B scaffolding

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add metering and billing to rate limit check

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply changes from testing

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* See if skipping product fixes build

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* appease vale

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Finishing draft, adding concept diagram and words

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix diagram, dev edit

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* remove colors

* Apply suggestions from code review

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Angel <angel.guarisma@konghq.com>

* Feat(Metering & Billing): Billing and subscriptions (#3695)

* billing and subs

* rework billing page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* appease vale by turning it off the tables

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

* Apply suggestions from code review

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix naming variable usage, remove get started from landing page and replace with learn more

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat(Metering&Billing): API addition (#3711)

* api

* api action

* feat(metering): Metering reference page (#3704)

* draft metering page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* appease vale

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update app/metering-and-billing/metering.md

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* add M&B roles

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix frontmatter

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix broken links hopefully

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix build issue

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Attempt to fix icon, nav item, and color

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* apply feedback, change M&B color for top nav, remove discounts page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix get started guide

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix customer endpoint, add get started to landing page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* new metering spec (#3742)

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Angel <angel.guarisma@konghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants