{ "openapi": "3.0.3", "info": { "title": "Astro — API de integração", "description": "Rotas autenticadas por chave de API (header x-api-key). Guia: /docs/desenvolvedores/api. Eventos: /docs/desenvolvedores/webhooks.", "version": "0.1.0" }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": {} }, "paths": { "/developer/v1/analytics/events": { "post": { "operationId": "ingestAnalyticsEvent", "tags": [ "developer-platform" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "subjectId": { "type": "string", "minLength": 1, "maxLength": 160 }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 200 }, "occurredAt": { "default": "2026-11-13T02:57:28.960Z" }, "properties": { "default": {}, "type": "object", "additionalProperties": {} } }, "required": [ "name", "idempotencyKey" ] } } } }, "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/analytics/daily": { "get": { "operationId": "listApiKeyDailyAnalytics", "tags": [ "developer-platform" ], "parameters": [ { "schema": {}, "in": "query", "name": "from", "required": true }, { "schema": {}, "in": "query", "name": "to", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/analytics/{report}": { "get": { "operationId": "getApiKeyAnalyticsReport", "tags": [ "developer-platform", "analytics" ], "parameters": [ { "schema": { "default": "30d", "type": "string", "enum": [ "24h", "7d", "30d", "90d", "12m" ] }, "in": "query", "name": "period", "required": false }, { "schema": { "default": "json", "type": "string", "enum": [ "json", "csv" ] }, "in": "query", "name": "format", "required": false }, { "schema": {}, "in": "query", "name": "from", "required": false }, { "schema": {}, "in": "query", "name": "to", "required": false }, { "schema": { "default": "", "type": "string", "maxLength": 160 }, "in": "query", "name": "q", "required": false }, { "schema": { "default": "all", "type": "string", "maxLength": 40 }, "in": "query", "name": "status", "required": false }, { "schema": { "default": "all", "type": "string", "maxLength": 80 }, "in": "query", "name": "gateway", "required": false }, { "schema": { "default": "all", "type": "string", "maxLength": 80 }, "in": "query", "name": "product", "required": false }, { "schema": { "default": "all", "type": "string", "maxLength": 80 }, "in": "query", "name": "checkout", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 250 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "total-revenue", "revenue-change", "approved-orders", "average-ticket", "conversion-rate", "mrr", "churn-rate", "active-subscriptions", "payment-success-rate", "total-refunded", "recovered-sales", "revenue-over-time", "orders-over-time", "average-ticket-over-time", "mrr-over-time", "conversion-over-time", "subscriptions-created-vs-canceled", "revenue-by-gateway", "orders-by-gateway", "revenue-by-product", "orders-by-product", "orders-by-payment-method", "revenue-by-checkout", "customers-by-plan", "checkouts-by-revenue", "checkouts-by-sales", "checkouts-by-conversion", "checkout-visits", "checkout-funnel", "cart-abandonment-rate", "new-vs-returning-customers", "average-ltv", "subscriptions-by-status", "subscription-renewals", "orders", "subscriptions", "customers", "refunds", "activity", "failed-payment-attempts", "platform-usage", "revenue-projection" ] }, "in": "path", "name": "report", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/products": { "get": { "operationId": "listApiKeyProducts", "tags": [ "developer-platform", "catalog" ], "parameters": [ { "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "after", "required": false } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "shortDescription": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "imageFileId": { "nullable": true, "type": "string" }, "color": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "inventoryMode": { "type": "string" }, "deliveryMode": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} }, "version": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "type", "name", "slug", "shortDescription", "description", "imageFileId", "color", "status", "inventoryMode", "deliveryMode", "metadata", "version", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "nextCursor": { "nullable": true, "type": "string" } }, "required": [ "nextCursor" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/products/{id}": { "get": { "operationId": "getApiKeyProduct", "tags": [ "developer-platform", "catalog" ], "parameters": [ { "schema": { "type": "string", "pattern": "^prd_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/products/{id}/prices": { "get": { "operationId": "listApiKeyProductPrices", "tags": [ "developer-platform", "catalog" ], "parameters": [ { "schema": { "type": "string", "pattern": "^prd_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/products/{id}/variants": { "get": { "operationId": "listApiKeyProductVariants", "tags": [ "developer-platform", "catalog" ], "parameters": [ { "schema": { "type": "string", "pattern": "^prd_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/customers": { "get": { "operationId": "listApiKeyCustomers", "tags": [ "developer-platform", "commerce" ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/customers/{id}": { "get": { "operationId": "getApiKeyCustomer", "tags": [ "developer-platform", "commerce" ], "parameters": [ { "schema": { "type": "string", "pattern": "^cus_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/customers/{id}/orders": { "get": { "operationId": "listApiKeyCustomerOrders", "tags": [ "developer-platform", "commerce" ], "parameters": [ { "schema": { "type": "string", "pattern": "^cus_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/orders": { "get": { "operationId": "listApiKeyOrders", "tags": [ "developer-platform", "commerce" ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/orders/{id}": { "get": { "operationId": "getApiKeyOrder", "tags": [ "developer-platform", "commerce" ], "parameters": [ { "schema": { "type": "string", "pattern": "^ord_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions": { "get": { "operationId": "listApiKeySubscriptions", "tags": [ "developer-platform", "subscriptions" ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions/{id}": { "get": { "operationId": "getApiKeySubscription", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/customers/{id}/subscriptions": { "get": { "operationId": "listApiKeyCustomerSubscriptions", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "pattern": "^cus_.*" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions/{id}/timeline": { "get": { "operationId": "getApiKeySubscriptionTimeline", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions/{id}/cycles": { "get": { "operationId": "getApiKeySubscriptionCycles", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions/{id}/invoices": { "get": { "operationId": "listApiKeySubscriptionInvoices", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/invoices": { "get": { "operationId": "listApiKeyInvoices", "tags": [ "developer-platform", "subscriptions" ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/invoices/{id}": { "get": { "operationId": "getApiKeyInvoice", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/invoices/{id}/timeline": { "get": { "operationId": "getApiKeyInvoiceTimeline", "tags": [ "developer-platform", "subscriptions" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/usage": { "post": { "operationId": "recordPlatformUsage", "tags": [ "platform-billing" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "feature": { "type": "string", "minLength": 1, "maxLength": 100 }, "quantity": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 200 }, "occurredAt": { "default": "2026-11-13T02:57:28.963Z" }, "metadata": { "default": {}, "type": "object", "additionalProperties": {} } }, "required": [ "feature", "quantity", "idempotencyKey" ] } } } }, "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/usage/{feature}": { "get": { "operationId": "getApiKeyFeatureStatus", "tags": [ "platform-billing" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "feature", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/checkout-sessions": { "post": { "operationId": "createApiKeyCheckoutSession", "tags": [ "developer-platform", "public-checkout" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "priceId": { "type": "string", "pattern": "^pri_.*" }, "variantId": { "type": "string", "pattern": "^var_.*" }, "quantity": { "type": "number", "minimum": 0, "exclusiveMinimum": true, "maximum": 100 } }, "required": [ "priceId", "quantity" ], "additionalProperties": false } }, "checkout": { "type": "string", "minLength": 1, "maxLength": 120 }, "externalReference": { "type": "string", "minLength": 1, "maxLength": 160, "pattern": "^[\\w.:@|/+=-]+$" }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 } }, "uiMode": { "default": "hosted", "type": "string", "enum": [ "hosted", "embedded", "custom" ] }, "returnUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 8, "maxLength": 30 }, "documentType": { "type": "string", "maxLength": 20 }, "documentNumber": { "type": "string", "maxLength": 40 } }, "required": [ "email" ] } }, "required": [ "items", "checkout" ] } } } }, "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/payments": { "get": { "operationId": "listApiKeyPayments", "tags": [ "developer-platform", "payments" ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/payments/{id}": { "get": { "operationId": "getApiKeyPayment", "tags": [ "developer-platform", "payments" ], "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/developer/v1/subscriptions/{id}/cancel": { "post": { "operationId": "cancelApiKeySubscription", "tags": [ "developer-platform", "subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "atPeriodEnd": { "default": false, "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 5, "maxLength": 32 }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope_Response" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "tags": [ { "name": "catalog", "description": "Products, prices and variants." }, { "name": "public-checkout", "description": "Published checkout and public sessions." }, { "name": "commerce", "description": "Customers and orders." }, { "name": "payments", "description": "Gateway connections, payments, refunds and webhooks." }, { "name": "subscriptions", "description": "Recurring subscriptions and invoices." }, { "name": "developer-platform", "description": "API keys and tenant analytics." }, { "name": "analytics", "description": "Business analytics and CSV reports." }, { "name": "platform-billing", "description": "Astro plans, entitlements and metered usage." } ] }