Skip to content

Update Asgardeo billing portal docs for resource-based (PAYG) subscriptions#6246

Open
Lakshan-Banneheke wants to merge 4 commits into
wso2:masterfrom
Lakshan-Banneheke:billing-docs
Open

Update Asgardeo billing portal docs for resource-based (PAYG) subscriptions#6246
Lakshan-Banneheke wants to merge 4 commits into
wso2:masterfrom
Lakshan-Banneheke:billing-docs

Conversation

@Lakshan-Banneheke

Copy link
Copy Markdown
Contributor

Purpose

Updates the Subscribe via Billing Portal guide to reflect the redesigned Asgardeo billing portal, which moves from the previous tier-based model (Free/Essentials/Professional/Enterprise with B2C/B2B/B2E use cases) to the new resource-based, Pay-As-You-Go (PAYG) model.

Key documentation changes:

  • New tier structure: Free / Growth / Enterprise.
  • Documents the multi-step subscription wizard: Subscription → Usage → Support → Review → Done.
  • New sections for resource commitments (Monthly Active Users, M2M tokens, AgentID tokens) with overage billing, and pay-per-use resources (Organizations, Enterprise Connections).
  • Updated support plans: Community / Standard / Enterprise.
  • Removed obsolete concepts (Essentials/Professional tiers, B2C/B2B/B2E use cases, annual billing).
  • Documents self-service subscription cancellation and commitment adjustment from the Overview page.
  • Refreshed screenshots for the new UI.

Related PRs

Test environment

Documentation-only change. Verified locally with mkdocs serve (mkdocs 1.6.1); page renders correctly and all image references resolve.

Security checks

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Lakshan-Banneheke, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 47 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 09b10e87-57c9-42fa-a95f-ea6a2434692b

📥 Commits

Reviewing files that changed from the base of the PR and between fd4654d and 0b78fc6.

📒 Files selected for processing (1)
  • en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md
📝 Walkthrough

Walkthrough

The subscribe-via-billing-portal.md guide was rewritten to document a five-step subscription wizard, updated plan and resource details, billing and invoice management, and revised subscription adjustment and cancellation procedures.

Changes

Billing Portal Documentation Update

Layer / File(s) Summary
Intro messaging and subscription wizard flow
en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md
Introductory text now describes Free, Growth, and Enterprise upgrade paths and links to pricing details; subscription instructions use a Subscription → Usage → Support → Review → Done wizard with updated confirmation guidance.
Plan details, tiers, and resource pricing
en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md
The Plan details section adds tier descriptions, Growth commitment and overage rules, pay-per-use quantities and billing, and support plan information.
Billing management and cancellation
en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md
Billing and invoice instructions are updated, while adjustment and cancellation guidance now describes wizard reopening and immediate organization deactivation on cancellation.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR's main change: updating billing portal docs for the new PAYG subscription model.
Description check ✅ Passed The description follows the template with Purpose, Related PRs, Test environment, and Security checks filled in.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md (1)

11-11: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use the repository’s log in wording here.

Sign in conflicts with the repository convention for user actions. Change this to Log in to keep the guide consistent. As per coding guidelines, use log in as the verb and login as the noun/adjective consistently.

Suggested fix
-1. Sign in to the WSO2 Identity Platform Console.
+1. Log in to the WSO2 Identity Platform Console.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md`
at line 11, The step text uses “Sign in” instead of the repository’s user-action
wording. Update the affected sentence in the subscription guide to use “Log in”
consistently, and keep the repo convention of using “log in” as the verb form
(with “login” only as a noun/adjective) across this document.

Sources: Coding guidelines, Learnings

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In
`@en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md`:
- Line 11: The step text uses “Sign in” instead of the repository’s user-action
wording. Update the affected sentence in the subscription guide to use “Log in”
consistently, and keep the repo convention of using “log in” as the verb form
(with “login” only as a noun/adjective) across this document.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: d3df18b0-59c3-4d71-91a4-207161cee7d4

📥 Commits

Reviewing files that changed from the base of the PR and between 4865946 and b74b442.

⛔ Files ignored due to path filters (7)
  • en/asgardeo/docs/assets/img/guides/billing/cancel.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/overview.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-review.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-select-tier.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-support.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-usage-commitments.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-usage-ppu.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md


## Downgrade/Cancel your subscription
!!! warning
Cancelling this subscription will immediately deactivate the organization, including all applications, authentication flows, and related services. You will no longer be able to access or use this organization after cancellation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You will no longer be able to access or use this organization -> is this correct? ideally users can continue to use the same org with the downgraded plan, isn't it? since the trial is ended users may not be able to do anything, but should we block access?

@Lakshan-Banneheke Lakshan-Banneheke Jul 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is actually not related to the trial expiry. Trial expiry will be handled separately and the org will be downgraded to free tier.

This is in relation to a user who initially had a paid subscription, clicking on the Cancel button.

As per a previous discussion in the Product Council, it had been decided to deactivate the org when the above occurs.

However, we can consider downgrading them to the free tier as well. I'll look into it and see if we can revisit that decision.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

However, we can consider downgrading them to the free tier as well. I'll look into it and see if we can revisit that decision.

Yes, that would be the better path AFAIU. Deactivating the org on cancelling subscription feels hostile.

To upgrade your subscription:

1. Sign in to the WSO2 Identity Platform Console.
1. Log in to the WSO2 Identity Platform Console.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any reason this was changed? Sign in is the better option for a user action.

@Lakshan-Banneheke Lakshan-Banneheke Jul 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This was changed due to a comment by Coderabbit. #6246 (review)

Use the repository’s log in wording here.

Sign in conflicts with the repository convention for user actions. Change this to Log in to keep the guide consistent. As per coding guidelines, use log in as the verb and login as the noun/adjective consistently.

Shall I switch back to Sign in?

…bscribe-via-billing-portal.md

Co-authored-by: Himesh Siriwardana <himesh.siriwardana@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md`:
- Line 116: Bold the “Growth” plan name in the subscription guidance paragraph,
matching the existing formatting used for other Growth references and preserving
the surrounding text and UI-label formatting.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: c823f766-267b-44ac-b97d-aa9d09ebe71a

📥 Commits

Reviewing files that changed from the base of the PR and between b74b442 and fd4654d.

⛔ Files ignored due to path filters (7)
  • en/asgardeo/docs/assets/img/guides/billing/cancel.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/overview.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-review.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-select-tier.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-support.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-usage-commitments.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/billing/step-usage-ppu.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • en/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md

…bscribe-via-billing-portal.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants