Feat: Metering and Billing customer entity#3540
Feat: Metering and Billing customer entity#3540cloudjumpercat merged 7 commits intorelease/konnect-metering-and-billingfrom
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
cloudjumpercat
left a comment
There was a problem hiding this comment.
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
There was a problem hiding this comment.
You can delete this file as I've added all the relevant info from this to the Customers page.
app/metering-and-billing/subjects.md
Outdated
There was a problem hiding this comment.
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." |
app/metering-and-billing/customer.md
Outdated
| @@ -0,0 +1,190 @@ | |||
| --- | |||
| title: "Customers and usage attributes" | |||
There was a problem hiding this comment.
Customers and usage attribution
app/metering-and-billing/customer.md
Outdated
|
|
||
| Customers represent individuals or organizations that subscribe to plans and gain access to features. | ||
|
|
||
| Billable events ingested into OpenMeter always include a usage attribute. |
There was a problem hiding this comment.
Billable events ingested into Metering & Billing always include a
subjectfield that represents metered entities within your system, such as {{site.base_gateway}} Consumers, Dev Portal applications, or entities outside of {{site.konnect_short_name}}).
app/metering-and-billing/customer.md
Outdated
| key: recommendation | ||
| rows: | ||
| - use-case: | | ||
| Attribute AI token usage to customers. |
There was a problem hiding this comment.
Attribute Kong AI Gateway token usage to customers.
app/metering-and-billing/customer.md
Outdated
| Attribute AI token usage to customers. | ||
| recommendation: "[Consumers](/gateway/entities/consumer/)" | ||
| - use-case: | | ||
| Attribute API request usage to customers. |
There was a problem hiding this comment.
Attribute Kong API Gateway requests to customers.
app/metering-and-billing/customer.md
Outdated
| Attribute API request usage to customers. | ||
| recommendation: "[Consumers](/gateway/entities/consumer/)" | ||
| - use-case: | | ||
| Attribute Dev Portal application usage to customers. |
There was a problem hiding this comment.
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. |
app/metering-and-billing/customer.md
Outdated
| 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. | ||
|
|
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Do we call it Dev Portal or Developer Portal?
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
6b22143
into
release/konnect-metering-and-billing
* 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>
Description
Fixes #3342
Preview Links
https://deploy-preview-3540--kongdeveloper.netlify.app/metering-and-billing/customer/
Checklist
descriptionentry in frontmatter.