-
Notifications
You must be signed in to change notification settings - Fork 3
docs(docs): migrate GET /api/credits/get + GET /api/subscription/status #181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arpitgupta1214
wants to merge
3
commits into
main
Choose a base branch
from
migrate/billing-group3
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
5466fcf
docs(docs): migrate GET /api/credits/get + GET /api/subscription/status
arpitgupta1214 c818bbb
docs(docs): adopt REST conventions for billing reads
arpitgupta1214 15931c9
docs(docs): rename subscription read to GET /api/subscription (singular)
arpitgupta1214 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: 'Get Credits' | ||
| openapi: '/api-reference/openapi/billing.json GET /api/credits' | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: 'Subscription Status' | ||
| openapi: '/api-reference/openapi/billing.json GET /api/subscription' | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| { | ||
| "openapi": "3.1.0", | ||
| "info": { | ||
| "title": "Recoup API - Billing", | ||
| "description": "API documentation for the Recoup platform - an AI agent platform for the music industry", | ||
| "license": { | ||
| "name": "MIT" | ||
| }, | ||
| "version": "1.0.0" | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "https://recoup-api.vercel.app" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/api/credits": { | ||
| "get": { | ||
| "description": "Returns the credit balance for the authenticated account, automatically resetting the balance when the account is on a refill cycle (monthly cadence or just-activated subscription). Honors both account-level and organization-level Stripe subscriptions when deciding whether the refill should use the pro tier.", | ||
| "security": [ | ||
| { | ||
| "apiKeyAuth": [] | ||
| }, | ||
| { | ||
| "bearerAuth": [] | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Credits retrieved (and refilled if eligible).", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/CreditsGetResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "Authentication required or invalid.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/BillingErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Internal server error.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/BillingErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/api/subscription": { | ||
| "get": { | ||
| "description": "Returns whether the authenticated account is on a pro subscription. An account is considered pro if it has an active Stripe subscription itself, or if any of its organizations does.", | ||
| "security": [ | ||
| { | ||
| "apiKeyAuth": [] | ||
| }, | ||
| { | ||
| "bearerAuth": [] | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Pro status retrieved.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SubscriptionStatusResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "Authentication required or invalid.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/BillingErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Internal server error.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/BillingErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "securitySchemes": { | ||
| "bearerAuth": { | ||
| "type": "http", | ||
| "scheme": "bearer" | ||
| }, | ||
| "apiKeyAuth": { | ||
| "type": "apiKey", | ||
| "in": "header", | ||
| "name": "x-api-key", | ||
| "description": "Your Recoup API key. [Learn more](/quickstart#api-keys)." | ||
| } | ||
| }, | ||
| "schemas": { | ||
| "CreditsGetResponse": { | ||
| "type": "object", | ||
| "required": [ | ||
| "data" | ||
| ], | ||
| "properties": { | ||
| "data": { | ||
| "oneOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/CreditsUsage" | ||
| }, | ||
| { | ||
| "type": "null" | ||
| } | ||
| ], | ||
| "description": "The authenticated account's credits usage row, or null when the account has no credits row yet." | ||
| } | ||
| } | ||
| }, | ||
| "CreditsUsage": { | ||
| "type": "object", | ||
| "required": [ | ||
| "account_id", | ||
| "remaining_credits" | ||
| ], | ||
| "properties": { | ||
| "account_id": { | ||
| "type": "string", | ||
| "description": "The Recoup account ID." | ||
| }, | ||
| "remaining_credits": { | ||
| "type": "number", | ||
| "description": "Remaining credits for the account." | ||
| }, | ||
| "timestamp": { | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "format": "date-time", | ||
| "description": "ISO timestamp of the last credits refill." | ||
| } | ||
| } | ||
| }, | ||
| "SubscriptionStatusResponse": { | ||
| "type": "object", | ||
| "required": [ | ||
| "isPro" | ||
| ], | ||
| "properties": { | ||
| "isPro": { | ||
| "type": "boolean", | ||
| "description": "True when the account or any of its organizations has an active Stripe subscription." | ||
| } | ||
| } | ||
| }, | ||
| "BillingErrorResponse": { | ||
| "type": "object", | ||
| "required": [ | ||
| "message" | ||
| ], | ||
| "properties": { | ||
| "message": { | ||
| "type": "string", | ||
| "description": "Human-readable error message." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P3: Custom agent: Enforce Clear Code Style and Maintainability Practices
New file exceeds the 100-line file limit required by Rule 2.
Prompt for AI agents