--- title: Read billing configuration description: Requires a user token with billing.details.read and organization owner access. Organization API keys cannot use this operation. Read-only; does not create or link a payment account. Includes full current subscriptions, plan catalog and top-up setting… type: api-reference source: ./openapi/inth-api.json method: get path: /v1/billing/configuration operationId: getBillingConfiguration server: https://api.inth.com apiVersion: 1.0.0 tags: - Billing canonicalUrl: https://inth.com/docs/rest-api/billing/get-billing-configuration lastModified: "2026-10-30T13:05:44.605Z" --- ```http GET /v1/billing/configuration ``` Server: `https://api.inth.com` Operation ID: `getBillingConfiguration` Requires a user token with billing.details.read and organization owner access. Organization API keys cannot use this operation. Read-only; does not create or link a payment account. Includes full current subscriptions, plan catalog and top-up settings. Null plan and hasBillingAccount indicate provider unavailability. ## Authentication * bearerAuth ### Schemes * bearerAuth: http / bearer - Use an Inth API key or OAuth access token in the Authorization header. Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (\`organizations.read\`, \`projects.read\`, \`projects.write\`, \`api-keys.read\`, \`inbox.read\`, \`billing.read\`), so writes that name the person who made them, such as \`inbox.write\` and \`vendors.write\`, need a user token. A credential without the capability an operation needs is answered with \`403 INSUFFICIENT\_SCOPE\`. \`GET /v1/me\` reports the capabilities of the calling credential. OAuth scopes: - \`organizations.read\`: List the organizations you belong to. - \`organizations.write\`: Create organizations you will own. - \`projects.read\`: Read projects, their consent configuration, and the vendors seen on them. - \`projects.write\`: Create, update, and delete projects and their consent configuration. - \`members.read\`: Read member names, email addresses, profile images, roles, and pending invitation email addresses. - \`members.write\`: Invite members, change member roles, remove members, and cancel invitations. - \`api-keys.read\`: List organization API keys. - \`api-keys.write\`: Create, roll, and delete organization API keys. - \`code-audit.read\`: Read Code Audit scans, their findings, and connected repositories. - \`code-audit.write\`: Start Code Audit scans and unlock their reports. - \`inbox.read\`: Read Inbox findings. - \`inbox.write\`: Change Inbox status or assignment and open GitHub issues for findings. - \`vendors.write\`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings. - \`billing.read\`: Read the plan and credit balance of an organization. - \`billing.details.read\`: Read invoices, billing profiles, and payment method summaries for organizations you own. - \`consent.read\`: Read consent records, analytics, configuration, and runtime status. - \`consent.write\`: Update consent settings, translations, IAB configuration, and policies. - \`consent.keys.read\`: Read consent runtime key metadata. Secret values are never returned. - \`website-audit.read\`: Read website audit targets, scans, reports, cookies, and evidence. - \`website-audit.write\`: Manage website audit targets, verify domains, review findings, and start scans. - \`account.read\`: Read your account profile. - \`notifications.read\`: Read your notification preferences and organization routing. - \`organization-retention.read\`: Read organization provider data retention policy. - \`support.read\`: Read support conversations you own or can access through sharing. - \`support.write\`: Create support conversations, send messages, share or close them, and upload support attachments. - \`consent.lifecycle.write\`: Update, upgrade or delete Consent runtimes. - \`consent.keys.write\`: Create, rotate and revoke Consent runtime keys. - \`billing.write\`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows. - \`account.security.read\`: Read your active browser sessions and connected device grants. - \`account.security.write\`: Revoke your browser sessions and connected device grants. - \`integrations.read\`: Read connected integration accounts, repositories, provider properties and project links. - \`integrations.write\`: Connect and sync providers, manage repository settings, project links and paid pull request monitoring. - \`account.write\`: Update your name, avatar and PII masking preference. - \`account.delete\`: Permanently delete your account after ownership checks and confirmation. - \`notifications.write\`: Update your notification preferences. - \`notifications.routing.write\`: Manage organization notification routing. - \`organization-retention.write\`: Change organization provider data retention policy. - \`organizations.settings.write\`: Update organization name, logo and slug. - \`organizations.delete\`: Permanently delete organizations you own after confirmation. - \`agents.read\`: Read your Inth Agent chats and chats shared with your organization. - \`agents.write\`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits. ## Request ### Query Parameters |Name|Type|Required|Description| |:--|:--|:--|:--| |`organizationId`|string|optional|Organization ID. Pass an explicit ID for stable automation; defaults to the active organization.| ## Code Examples ### cURL ```bash curl -X GET "https://api.inth.com/v1/billing/configuration" \ -H "Authorization: Bearer " ``` ### JavaScript ```ts const response = await fetch("https://api.inth.com/v1/billing/configuration", { method: "GET", headers: { "Authorization": "Bearer " }, }); const data = await response.json(); ``` ## Responses ### 200 Read billing configuration Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`data`|object|required|| |`data.organizationId`|string|required|| |`data.plan`|object \|null|required|| |`data.catalogPlans`|object\[]|required|| |`data.catalogPlans[].items`|object\[]|required|| |`data.catalogPlans[].items[].displayPrimaryText`|string \|null|required|| |`data.catalogPlans[].items[].displaySecondaryText`|string \|null|required|| |`data.catalogPlans[].items[].featureId`|string|required|| |`data.catalogPlans[].items[].featureName`|string \|null|required|| |`data.catalogPlans[].items[].featureType`|string \|null|required|| |`data.catalogPlans[].items[].included`|number \|"Infinity" \|"-Infinity" \|"NaN"|required|| |`data.catalogPlans[].items[].price`|object \|null|required|| |`data.catalogPlans[].items[].resetInterval`|string \|null|required|| |`data.catalogPlans[].items[].unlimited`|boolean|required|| |`data.catalogPlans[].name`|string|required|| |`data.catalogPlans[].planId`|string|required|| |`data.catalogPlans[].price`|object \|null|required|| |`data.catalogPlans[].status`|string \|null|required|| |`data.creditTopUp`|object \|null|required|| |`data.creditAutoTopUp`|object \|object \|object \|null|required|| |`data.hasBillingAccount`|boolean \|null|required|| |`data.providerAvailable`|boolean|required|| Example: ```json { "success": true, "data": { "organizationId": "string", "plan": {}, "catalogPlans": [ { "items": [ { "displayPrimaryText": "string", "displaySecondaryText": "string", "featureId": "string", "featureName": "string", "featureType": "string", "included": 0, "price": {}, "resetInterval": "string", "unlimited": true } ], "name": "string", "planId": "string", "price": {}, "status": "string" } ], "creditTopUp": {}, "creditAutoTopUp": {}, "hasBillingAccount": true, "providerAvailable": true } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "properties": { "organizationId": { "type": "string" }, "plan": { "anyOf": [ { "type": "object", "properties": { "consent": { "type": "object", "properties": { "billingInterval": { "anyOf": [ { "type": "string", "enum": [ "month", "year" ] }, { "type": "null" } ] }, "name": { "type": "string" }, "pastDue": { "type": "boolean" }, "relation": { "type": "string", "enum": [ "included-with-inth", "standalone", "free-fallback" ] }, "current": { "anyOf": [ { "type": "object", "properties": { "cancelAtPeriodEnd": { "type": "boolean" }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextPlan": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "planId": { "type": "string" }, "startsAt": { "type": "string" } }, "required": [ "name", "planId", "startsAt" ], "additionalProperties": false }, { "type": "null" } ] }, "planId": { "type": "string" }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "projects": { "anyOf": [ { "type": "object", "properties": { "included": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "billingMethod": { "type": "string" }, "billingUnits": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "billingMethod", "billingUnits", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "unlimited": { "type": "boolean" } }, "required": [ "included", "price", "unlimited" ], "additionalProperties": false }, { "type": "null" } ] }, "status": { "type": "string" } }, "required": [ "currentPeriodEnd", "planId", "price", "status" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "billingInterval", "name", "pastDue", "relation", "current" ], "additionalProperties": false }, "credits": { "anyOf": [ { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "unlimited": { "type": "boolean" } }, "required": [ "remaining", "unlimited" ], "additionalProperties": false }, { "type": "null" } ] }, "inth": { "anyOf": [ { "type": "object", "properties": { "billingInterval": { "anyOf": [ { "type": "string", "enum": [ "month", "year" ] }, { "type": "null" } ] }, "family": { "type": "string", "enum": [ "free", "starter", "pro", "business", "startup", "enterprise" ] }, "name": { "type": "string" }, "pastDue": { "type": "boolean" }, "current": { "type": "object", "properties": { "cancelAtPeriodEnd": { "type": "boolean" }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextPlan": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "planId": { "type": "string" }, "startsAt": { "type": "string" } }, "required": [ "name", "planId", "startsAt" ], "additionalProperties": false }, { "type": "null" } ] }, "planId": { "type": "string" }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "projects": { "anyOf": [ { "type": "object", "properties": { "included": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "billingMethod": { "type": "string" }, "billingUnits": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "billingMethod", "billingUnits", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "unlimited": { "type": "boolean" } }, "required": [ "included", "price", "unlimited" ], "additionalProperties": false }, { "type": "null" } ] }, "status": { "type": "string" } }, "required": [ "currentPeriodEnd", "planId", "price", "status" ], "additionalProperties": false } }, "required": [ "billingInterval", "family", "name", "pastDue", "current" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "consent", "credits", "inth" ], "additionalProperties": false }, { "type": "null" } ] }, "catalogPlans": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "displayPrimaryText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displaySecondaryText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "featureId": { "type": "string" }, "featureName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "featureType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "included": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "billingMethod": { "type": "string" }, "billingUnits": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "billingMethod", "billingUnits", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "resetInterval": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "unlimited": { "type": "boolean" } }, "required": [ "displayPrimaryText", "displaySecondaryText", "featureId", "featureName", "featureType", "included", "price", "resetInterval", "unlimited" ], "additionalProperties": false } }, "name": { "type": "string" }, "planId": { "type": "string" }, "price": { "anyOf": [ { "type": "object", "properties": { "amount": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "interval": { "type": "string" } }, "required": [ "amount", "interval" ], "additionalProperties": false }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "name", "planId", "price", "status" ], "additionalProperties": false } }, "creditTopUp": { "anyOf": [ { "type": "object", "properties": { "billingUnits": { "type": "integer", "exclusiveMinimum": 0 }, "currency": { "type": "string", "enum": [ "USD" ] }, "minimumCredits": { "type": "integer", "exclusiveMinimum": 0 }, "planVersion": { "type": "integer", "exclusiveMinimum": 0 }, "priceCents": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "billingUnits", "currency", "minimumCredits", "planVersion", "priceCents" ], "additionalProperties": false }, { "type": "null" } ] }, "creditAutoTopUp": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "billingUnits": { "type": "integer", "exclusiveMinimum": 0 }, "enabled": { "type": "boolean" }, "monthlyPurchaseLimit": { "type": "integer", "exclusiveMinimum": 0 }, "planVersion": { "type": "integer", "exclusiveMinimum": 0 }, "priceCents": { "type": "integer", "exclusiveMinimum": 0 }, "quantityCredits": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "configured" ] }, "thresholdCredits": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "billingUnits", "enabled", "monthlyPurchaseLimit", "planVersion", "priceCents", "quantityCredits", "status", "thresholdCredits" ], "additionalProperties": false }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "unsupported" ] } }, "required": [ "enabled", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "unreadable" ] } }, "required": [ "enabled", "status" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "hasBillingAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "providerAvailable": { "type": "boolean" } }, "required": [ "organizationId", "plan", "catalogPlans", "creditTopUp", "creditAutoTopUp", "hasBillingAccount", "providerAvailable" ], "additionalProperties": false } } } ``` ### 400 The request payload or parameters are invalid. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: default ```json { "success": false, "error": { "code": "INVALID_PAYLOAD", "message": "Invalid request payload", "details": [ { "code": "too_small", "message": "Too small: expected string to have >=1 characters", "path": [ "name" ] } ] } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ### 401 Authentication is missing, invalid, or expired. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: default ```json { "success": false, "error": { "code": "UNAUTHORIZED", "message": "Authentication required" } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ### 403 The credential is valid but may not perform the operation. \`INSUFFICIENT\_SCOPE\`: the credential was never granted the capability the operation needs. \`details.requiredScope\` names it, and the \`WWW-Authenticate\` header carries \`Bearer error="insufficient\_scope"\`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it. \`FORBIDDEN\`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: insufficientScope ```json { "success": false, "error": { "code": "INSUFFICIENT_SCOPE", "message": "This token was not granted the projects.write scope", "details": { "requiredScope": "projects.write" } } } ``` Example: forbidden ```json { "success": false, "error": { "code": "FORBIDDEN", "message": "Organization membership is required" } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` #### Headers |Name|Type|Required|Description| |:--|:--|:--|:--| |`WWW-Authenticate`|string|optional|Present on \`INSUFFICIENT\_SCOPE\`: \`Bearer error="insufficient\_scope", scope="\"\`.| ### 404 The requested resource was not found. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: ```json { "success": true, "error": { "code": "UNAUTHORIZED", "message": "string", "details": {} } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ### 503 The capability is temporarily paused by an operator. Retry later. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: default ```json { "success": false, "error": { "code": "SERVICE_UNAVAILABLE", "message": "Code Audit scans through the API are temporarily paused. Try again later." } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ## Related * [REST API overview](/docs/rest-api): Every operation in this API.