--- title: Get account credit balance url: https://developers.wpengine.com/docs/ai/api/reference/operations/getcredits/ image: https://developers.wpengine.com/og/docs/ai/api/reference/operations/getcredits.png --- # Get account credit balance GET /v1/credits Select code sample ```php request('GET', 'https://api.ai.wpengine.com/v1/credits', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` - Current environment Returns the authenticated account’s remaining credit balance, less usage recorded but not yet deducted from it. It can be negative. An account with no allocated balance reports zero. Usage already deducted can take about a minute to show, and up to an hour while the balance can’t be refreshed. Answers 503 with error type “balance_unavailable” when the balance can’t be read and no recent value is available; retry after the Retry-After header, in seconds. Requires account-level Okta authentication. ## Authorizations - **[bearerAuth](https://developers.wpengine.com/docs/ai/api/reference/#bearerauth)** ## Responses ### 200 The account’s remaining credit balance Media typeapplication/json object **credits_nano** required Remaining credit balance, in exact integer nanocredits (1 credit = 1,000,000,000 nanocredits). Divide by 1,000,000,000 to get credits. It can be negative. integer format: int64 #### Example ```json { "credits_nano": 42500000000 } ``` ### 400 Invalid request body or parameters. On agent create and update, error type “profile_unavailable” means the requested profile is not available to the caller. Media typeapplication/json object **error** required object **message** required string **type** required string **error_code** Stable, machine-readable cause, set by routes that document their codes (the AI readiness and account AI routes, and an entitlement_required refusal, where it is one of not_eligible, terms_required, not_enabled or suspended); absent elsewhere and on errors from shared layers such as authentication. Clients must allow new codes. string **portal_url** Where the customer can resolve the error, set when one is configured on an entitlement_required refusal that has an error_code, and on a 402 insufficient_credits refusal (the credit purchase page). string **code** required integer **request_id** required Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports. string #### Example ```json { "error": { "type": "invalid_request_error", "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5" } } ``` ### 401 Missing or invalid bearer token Media typeapplication/json object **error** required object **message** required string **type** required string **error_code** Stable, machine-readable cause, set by routes that document their codes (the AI readiness and account AI routes, and an entitlement_required refusal, where it is one of not_eligible, terms_required, not_enabled or suspended); absent elsewhere and on errors from shared layers such as authentication. Clients must allow new codes. string **portal_url** Where the customer can resolve the error, set when one is configured on an entitlement_required refusal that has an error_code, and on a 402 insufficient_credits refusal (the credit purchase page). string **code** required integer **request_id** required Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports. string #### Example ```json { "error": { "type": "invalid_request_error", "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5" } } ``` #### Headers **WWW-Authenticate** string ##### Example ``` Bearer realm="ai-services" ``` ### 403 The token is valid, but the request is forbidden. Error type “permission_error” means the token’s scope/permission is insufficient or the authenticated user is not authorized for the target account; “entitlement_required” means the account may not use WP Engine AI, with error_code giving why when known (not_eligible, terms_required, not_enabled or suspended) and portal_url where to fix it; “account_required” means no billing account could be resolved; and “billing_account_pending” means billing isn’t set up for the account yet, usually because its setup after AI was turned on hasn’t finished. Retry shortly. On /v1/chat/completions when content moderation is enabled, and on /v1/sessions/{session_id}/events, error type “content_policy_violation” instead means the request content was blocked by content moderation policy; that response never identifies which filter or category matched. Media typeapplication/json object **error** required object **message** required string **type** required string **error_code** Stable, machine-readable cause, set by routes that document their codes (the AI readiness and account AI routes, and an entitlement_required refusal, where it is one of not_eligible, terms_required, not_enabled or suspended); absent elsewhere and on errors from shared layers such as authentication. Clients must allow new codes. string **portal_url** Where the customer can resolve the error, set when one is configured on an entitlement_required refusal that has an error_code, and on a 402 insufficient_credits refusal (the credit purchase page). string **code** required integer **request_id** required Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports. string #### Example ```json { "error": { "type": "invalid_request_error", "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5" } } ``` ### 503 A required dependency is temporarily unavailable. Retry after a short delay with exponential back-off. An entitlement lookup failure uses error type “entitlement_unavailable”. A model without complete rate coverage uses error type “model_unpriced”. A credit balance that can’t be read uses error type “balance_unavailable”. Media typeapplication/json object **error** required object **message** required string **type** required string **error_code** Stable, machine-readable cause, set by routes that document their codes (the AI readiness and account AI routes, and an entitlement_required refusal, where it is one of not_eligible, terms_required, not_enabled or suspended); absent elsewhere and on errors from shared layers such as authentication. Clients must allow new codes. string **portal_url** Where the customer can resolve the error, set when one is configured on an entitlement_required refusal that has an error_code, and on a 402 insufficient_credits refusal (the credit purchase page). string **code** required integer **request_id** required Correlation ID for this request, matching the X-Request-ID response header — a 32-character trace ID behind the load balancer, otherwise a UUID. Quote it in support reports. string #### Example ```json { "error": { "type": "invalid_request_error", "request_id": "80f1e2c3a4b5c6d7e8f9a0b1c2d3e4f5" } } ``` ## Was this helpful? Thanks for the feedback! ```json {"@context":"https://schema.org","@graph":[{"@type":"WebSite","@id":"https://developers.wpengine.com/#website","name":"WP Engine Product Documentation","url":"https://developers.wpengine.com/","description":"Resources for developing, deploying, and scaling on WP Engine.","inLanguage":"en-US","keywords":["API documentation","product documentation","headless WordPress","managed WordPress hosting"],"publisher":{"@id":"https://wpengine.com/#organization"}}]} ```