Skip to content

Add Billing parameters to redirect#83

Open
aarhus wants to merge 9 commits intokinde-oss:mainfrom
aarhus:main
Open

Add Billing parameters to redirect#83
aarhus wants to merge 9 commits intokinde-oss:mainfrom
aarhus:main

Conversation

@aarhus
Copy link

@aarhus aarhus commented Jun 25, 2025

Explain your changes

Adds the URL parameters (as per Kinde Billing Documentation ) to support the new billing features.

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Copilot AI review requested due to automatic review settings June 25, 2025 22:29
@aarhus aarhus requested a review from DaveOrDead as a code owner June 25, 2025 22:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request adds billing-related URL parameters to support new billing features. Key changes include:

  • Extending the RedirectOptions type with two new optional string properties: pricing_table_key and plan_interest.
  • Updating createKindeClient to accept and incorporate these new parameters into the URL search parameters.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/types.ts Added pricing_table_key and plan_interest to RedirectOptions.
src/createKindeClient.ts Introduced new destructured parameters and updated URL construction with billing parameters.

@coderabbitai
Copy link

coderabbitai bot commented Jun 25, 2025

Warning

Rate limit exceeded

@aarhus has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5c41da1 and 54d9767.

📒 Files selected for processing (2)
  • src/createKindeClient.ts (5 hunks)
  • src/types.ts (2 hunks)

Walkthrough

The changes introduce two new optional parameters, pricing_table_key and plan_interest, to the redirect functionality. These parameters are added to both the function signature and the type definitions, allowing them to be included as query parameters during redirection if provided. Additionally, a new asynchronous method getUserEntitlements was added to fetch user entitlements from the API.

Changes

File(s) Change Summary
src/createKindeClient.ts Updated redirectToKinde to accept and conditionally append pricing_table_key and plan_interest as query parameters; added new async method getUserEntitlements to fetch user entitlements.
src/types.ts Added optional pricing_table_key and plan_interest properties to the AuthOptions type.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant KindeClient
    participant EntitlementsAPI

    Caller->>KindeClient: redirectToKinde({..., pricing_table_key, plan_interest})
    KindeClient->>KindeClient: Add pricing_table_key and plan_interest to searchParams if provided
    KindeClient->>Kinde Authorization Endpoint: Redirect with constructed URL (including new params if present)

    Caller->>KindeClient: getUserEntitlements()
    KindeClient->>EntitlementsAPI: GET /account_api/v1/entitlements with access token
    EntitlementsAPI-->>KindeClient: User entitlements data
    KindeClient-->>Caller: Return entitlements data
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Fix to typo

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DanielRivers
Copy link
Member

Thank you for this, I will review in the morning BST 👍

@marcomow
Copy link

Thank you for this, I will review in the morning BST 👍

hi, any news on the review? :)

@onderay onderay requested review from DanielRivers and removed request for DaveOrDead October 16, 2025 07:43
Copy link

@p-stam001 p-stam001 left a comment

Choose a reason for hiding this comment

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

I checked this PR and it needs to be improved.

First, unknown error code '_link_expired'.
if (error?.toLowerCase() === '_link_expired') {

Second, remove any type.

  isAuthenticated: () => Promise<boolean>;
  getUser: () => KindeUser;
  getUserProfile: () => Promise<KindeUser | undefined>;
  getUserEntitlements: () => Promise<any | undefined>; //Should remove any type.
  login: (options?: AuthOptions) => Promise<void>;
  logout: () => Promise<void>;
  portal: (options: Omit<GeneratePortalUrlParams, 'domain'>) => Promise<void>;

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.

5 participants