Skip to content

docs: add subscription status endpoint to API documentation#151

Open
ahmednahima0-beep wants to merge 1 commit intorecoupable:mainfrom
ahmednahima0-beep:feat/migrate-get-subscription-status
Open

docs: add subscription status endpoint to API documentation#151
ahmednahima0-beep wants to merge 1 commit intorecoupable:mainfrom
ahmednahima0-beep:feat/migrate-get-subscription-status

Conversation

@ahmednahima0-beep
Copy link
Copy Markdown
Collaborator

@ahmednahima0-beep ahmednahima0-beep commented Apr 21, 2026

  • Updated the OpenAPI specification to include a new endpoint /api/subscription/status for checking the active pro subscription status of an account.
  • Added detailed descriptions for request parameters, response schemas, and error handling for various scenarios (200, 400, 401, 403).
  • Updated navigation in docs.json to include the new endpoint in the Subscriptions group.

Summary by cubic

Added API docs for a new endpoint that returns whether an account has an active pro subscription. This adds GET /api/subscription/status to the OpenAPI spec and navigation.

  • New Features
    • Added GET /api/subscription/status to OpenAPI; returns { isPro: boolean } by checking direct and org-level subscriptions.
    • Documented optional accountId query param, authentication (apiKeyAuth or bearerAuth), and responses for 200/400/401/403.
    • Added api-reference/subscriptions/status.mdx and updated docs.json to list the endpoint under Subscriptions.

Written for commit 2158fd9. Summary will update on new commits.

- Updated the OpenAPI specification to include a new endpoint `/api/subscription/status` for checking the active pro subscription status of an account.
- Added detailed descriptions for request parameters, response schemas, and error handling for various scenarios (200, 400, 401, 403).
- Updated navigation in `docs.json` to include the new endpoint in the Subscriptions group.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 21, 2026

Warning

Rate limit exceeded

@ahmednahima0-beep has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 28 minutes and 44 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 28 minutes and 44 seconds.

⌛ 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1b12ac58-654a-4a2d-9447-e2e874fe4c2d

📥 Commits

Reviewing files that changed from the base of the PR and between ea3c08a and 2158fd9.

📒 Files selected for processing (3)
  • api-reference/openapi/accounts.json
  • api-reference/subscriptions/status.mdx
  • docs.json
✨ 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 and usage tips.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

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.

1 participant