Skip to content

Document customerId on the plan cancellation request billing context - #825

Merged
panosatkinde merged 1 commit into
mainfrom
docs/plan-cancellation-customer-id
Oct 9, 2026
Merged

panosatkinde merged 1 commit into
mainfrom
docs/plan-cancellation-customer-id

Conversation

@panosatkinde

@panosatkinde panosatkinde commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The plan cancellation request workflow event now exposes the billing customer on context.billing. This page is the only docs source that shows that object, so the sample event is updated to include customerId immediately after agreementId.

Workflow authors can use customerId (format customer_xxxxx, for example customer_019e3e6346421b0df4dec6c4756b4953) to identify the billing customer when a cancellation is requested from the self-serve portal or the Kinde Management API. It is distinct from the subscription agreementId.

Changes

  • src/content/docs/workflows/example-workflows/plan-cancellation-request-workflow.mdx
    • Add customerId to the sample billing object, with a comment that it is the billing customer identifier.
    • Refresh the page updated date to 2026-10-08.

No other page documents this billing object. The plan selection workflow uses a different billing shape (currentPlanCode, requestedPlanCode) and was left unchanged. The cancellation eligibility tutorial only reads currentPlanCode and does not list the object.

Database

No database changes.

Summary by CodeRabbit

  • Documentation
    • Updated the plan cancellation workflow example with a billing customer ID and a newer revision date.

…text

Cancellation workflows can now identify the billing customer, so the sample event includes customerId alongside agreementId.
@panosatkinde
panosatkinde requested a review from a team as a code owner October 8, 2026 12:13
@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 19b58740-bbc0-4f20-b09f-6c00ffeacb47
📥 Commits

Reviewing files that changed from the base of the PR and between fa35fd0 and e28efb4.

📒 Files selected for processing (1)
  • src/content/docs/workflows/example-workflows/plan-cancellation-request-workflow.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The plan cancellation workflow example updates its updated date and adds a customerId field to the sample billing object.

Changes

Plan cancellation workflow example

Layer / File(s) Summary
Update workflow example
src/content/docs/workflows/example-workflows/plan-cancellation-request-workflow.mdx
The page’s updated date changes to 2026-10-08. The sample billing object retains its agreementId and adds a customerId value described as the billing customer identifier.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: danielrivers

Merge Risk: ⚪ Minimal · up to e28ef

The example can proceed through normal checks. Whether both cancellation paths populate the field remains unverified, but no concrete incompatibility has been established.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting customerId in the plan cancellation request billing context.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit reads the billing note,
A new customer joins the quote.
The date now marks October’s day,
The sample fields are set that way.
Then off the rabbit hops to play.

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

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: e28efb4
Status: ✅  Deploy successful!
Preview URL: https://bab137b5.kinde-docs-preview.pages.dev
Branch Preview URL: https://docs-plan-cancellation-custo.kinde-docs-preview.pages.dev

View logs

@panosatkinde
panosatkinde merged commit 5f8ee7c into main Oct 9, 2026
6 checks passed
@panosatkinde
panosatkinde deleted the docs/plan-cancellation-customer-id branch October 9, 2026 03:56
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.

2 participants