Skip to content

Automate browser based workflows with AI

docs: remove billing endpoints from public API reference (#6168)

Shuchang Zhengbee710ce4370
diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json
index b8fc02b4c..9eb59ec17 100644
--- a/docs/api-reference/openapi.json
+++ b/docs/api-reference/openapi.json
@@ -2277,146 +2277,6 @@
}
}
}
- },
- "/api/v1/billing/portal": {
- "post": {
- "summary": "Create Portal Session",
- "description": "Create a Stripe Customer Portal session for managing subscription.\n\nFrontend should redirect the user to the returned URL.\nThe portal allows users to:\n- Update payment methods\n- Upgrade/downgrade plans\n- Cancel subscription\n- View invoices",
- "operationId": "create_portal_session_api_v1_billing_portal_post",
- "parameters": [
- {
- "name": "x-api-key",
- "in": "header",
- "required": false,
- "schema": {
- "type": "string",
- "nullable": true,
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
- "title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PortalSessionResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/state": {
- "get": {
- "summary": "Get Organization Billing",
- "operationId": "get_organization_billing_api_v1_billing_state_get",
- "parameters": [
- {
- "name": "x-api-key",
- "in": "header",
- "required": false,
- "schema": {
- "type": "string",
- "nullable": true,
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
- "title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BillingStateResponse",
- "nullable": true,
- "title": "Response Get Organization Billing Api V1 Billing State Get"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/change-tier": {
- "post": {
- "summary": "Change Tier",
- "description": "Redirect to Stripe Portal for tier changes.\nPortal handles proration based on configured settings:\n- Upgrades: Immediate proration charge\n- Downgrades: Apply at end of billing period",
- "operationId": "change_tier_api_v1_billing_change_tier_post",
- "parameters": [
- {
- "name": "x-api-key",
- "in": "header",
- "required": false,
- "schema": {
- "type": "string",
- "nullable": true,
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
- "title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChangeTierRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChangeTierResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
}
},
"components": {