Skip to content

docs(docs): remove GET /api/subscriptions endpoint #159

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.

Sign up for GitHub

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

Merged
sweetmantech merged 1 commit into from
Apr 24, 2026
Merged

docs(docs): remove GET /api/subscriptions endpoint #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 0 additions & 262 deletions api-reference/openapi/accounts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,67 +354,6 @@
}
}
},
"/api/subscriptions": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve subscription information for an account. For accounts with enterprise plans, returns a simplified response indicating enterprise status. For standard accounts, returns the full Stripe subscription object.",
"parameters": [
{
"name": "accountId",
"in": "query",
"description": "The unique identifier of the account to query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Subscription information retrieved successfully",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionResponse"
},
{
"$ref": "#/components/schemas/EnterpriseSubscriptionResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request - missing or invalid accountId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"404": {
"description": "Account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionErrorResponse"
}
}
}
}
}
}
},
"/api/subscriptions/sessions": {
"post": {
"servers": [
Expand Down Expand Up @@ -2238,30 +2177,6 @@
}
}
},
"EnterpriseSubscriptionResponse": {
"type": "object",
"required": [
"status",
"isEnterprise"
],
"description": "Response for accounts with enterprise plans",
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"isEnterprise": {
"type": "boolean",
"enum": [
true
],
"description": "Indicates that the account has an enterprise plan"
}
}
},
"Error": {
"required": [
"error",
Expand Down Expand Up @@ -2661,183 +2576,6 @@
}
}
},
"StripeSubscription": {
"type": "object",
"description": "A Stripe subscription object. For detailed information about all available properties, see the Stripe Subscription API documentation: https://docs.stripe.com/api/subscriptions/retrieve",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the subscription"
},
"object": {
"type": "string",
"enum": [
"subscription"
],
"description": "String representing the object's type"
},
"customer": {
"type": "string",
"description": "ID of the customer who owns this subscription"
},
"status": {
"type": "string",
"enum": [
"active",
"canceled",
"incomplete",
"incomplete_expired",
"past_due",
"trialing",
"unpaid"
],
"description": "The status of the subscription"
},
"currency": {
"type": "string",
"description": "Three-letter ISO currency code"
},
"current_period_start": {
"type": "integer",
"description": "Start of the current period (Unix timestamp)"
},
"current_period_end": {
"type": "integer",
"description": "End of the current period (Unix timestamp)"
},
"cancel_at_period_end": {
"type": "boolean",
"description": "If true, the subscription will be canceled at the end of the current period"
},
"created": {
"type": "integer",
"description": "Time at which the subscription was created (Unix timestamp)"
},
"items": {
"type": "object",
"description": "List of subscription items, each with an attached price",
"properties": {
"object": {
"type": "string",
"enum": [
"list"
]
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"subscription_item"
]
},
"price": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"currency": {
"type": "string"
},
"unit_amount": {
"type": "integer",
"description": "Price amount in cents"
},
"recurring": {
"type": "object",
"properties": {
"interval": {
"type": "string",
"enum": [
"day",
"week",
"month",
"year"
]
},
"interval_count": {
"type": "integer"
}
}
}
}
},
"quantity": {
"type": "integer"
}
}
}
},
"has_more": {
"type": "boolean"
},
"total_count": {
"type": "integer"
}
}
},
"latest_invoice": {
"type": "string",
"description": "ID of the most recent invoice for this subscription"
},
"livemode": {
"type": "boolean",
"description": "Indicates if in live mode (true) or test mode (false)"
},
"metadata": {
"type": "object",
"description": "Set of key-value pairs attached to the subscription"
}
}
},
"SubscriptionErrorResponse": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the request"
},
"error": {
"type": "string",
"description": "Error message describing what went wrong"
}
}
},
"SubscriptionResponse": {
"type": "object",
"required": [
"status",
"subscription"
],
"description": "Response for standard accounts with Stripe subscriptions",
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"subscription": {
"$ref": "#/components/schemas/StripeSubscription",
"description": "The full Stripe subscription object"
}
}
},
"UpdateAccountRequest": {
"type": "object",
"required": [
Expand Down
4 changes: 0 additions & 4 deletions api-reference/subscriptions/get.mdx
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,6 @@
{
"group": "Subscriptions",
"pages": [
"api-reference/subscriptions/get",
"api-reference/subscriptions/sessions-create"
]
},
Expand Down