> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ibee.co.in/docs/api-reference/billing/check-resource-eligibility/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ibee.co.in/_mcp/server. # Check resource billing eligibility POST https://api.ibee.co.in/v1/billing/resource-eligibility Content-Type: application/json Returns a point-in-time eligibility decision from the same existing billing service used by the portal. Call it before a billable create and continue only when `allowed` is exactly `true`. This check does not reserve funds, create a resource, or guarantee that a later product operation will succeed. Requires scope: billing.read. Reference: https://docs.ibee.co.in/docs/api-reference/billing/check-resource-eligibility ## Authentication - `Authorization` header (bearer token, required) — IBEE platform API token. Production tokens start with `ibee_prod_key_`; development tokens start with `ibee_dev_key_`. Use a token only with its matching gateway environment. ## Servers - `https://api.ibee.co.in/v1` (Production, default) - `https://api.ibee.co.in/v1` (Development) ## Request ### Query parameters - `workspace_id` (string, required) — The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected. ### Body (application/json) This endpoint expects a BillingEligibilityRequest. - `sku_code` (string, optional) — Billing catalog SKU for the intended resource. Unknown or unavailable SKUs may be denied. - `estimated_cost_minor` (integer, optional) — Optional estimated cost expressed in the organization's currency minor unit. Use a value from a trusted catalog. ## Response ### 200 Billing eligibility decision returned successfully. - `organization_id` (string, required) - `allowed` (boolean, required) — Continue only when this value is exactly true. - `reason` (string, required) — Machine-readable decision reason. - `billing_mode` (enum, required) - Allowed values: `PREPAID`, `POSTPAID` - `billing_state` (enum, required) - Allowed values: `CURRENT`, `PAYMENT_DUE`, `PAST_DUE`, `SOFT_SUSPENDED`, `HARD_SUSPENDED` - `currency` (string, required) - `evaluated_at` (datetime, required) - `sku_code` (string, optional, nullable) - `estimated_cost_minor` (integer, optional, nullable) - `effective_balance_minor` (integer, optional, nullable) - `credit_headroom_minor` (integer, optional, nullable) ## Errors ### 400 Bad Request Error The request is invalid. - `detail` (ErrorDetail, optional) ### 401 Unauthorized Error The API token is missing or invalid. - `detail` (ErrorDetail, optional) ### 403 Forbidden Error The token is not allowed to access the workspace or does not have the required scope. - `detail` (ErrorDetail, optional) ### 422 Unprocessable Entity Error The eligibility request is invalid. - `detail` (ErrorDetail, optional) ### 502 Bad Gateway Error Billing returned an invalid or unavailable decision. - `detail` (ErrorDetail, optional) ### 504 Gateway Timeout Error The billing eligibility request timed out. - `detail` (ErrorDetail, optional) ## Types ### ErrorDetail ## Examples **Request** ```json { "sku_code": "STANDARD-2-8-50" } ``` **Response** ```json { "organization_id": "string", "allowed": true, "reason": "sufficient_balance", "billing_mode": "PREPAID", "billing_state": "CURRENT", "currency": "INR", "evaluated_at": "2024-01-15T09:30:00Z", "sku_code": "string", "estimated_cost_minor": 1, "effective_balance_minor": 1, "credit_headroom_minor": 1 } ``` **SDK Code** ```python Billing_checkResourceEligibility_example import requests url = "https://api.ibee.co.in/v1/billing/resource-eligibility" querystring = {"workspace_id":"710995"} payload = { "sku_code": "STANDARD-2-8-50" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript Billing_checkResourceEligibility_example const url = 'https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"sku_code":"STANDARD-2-8-50"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Billing_checkResourceEligibility_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995" payload := strings.NewReader("{\n \"sku_code\": \"STANDARD-2-8-50\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Billing_checkResourceEligibility_example require 'uri' require 'net/http' url = URI("https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"sku_code\": \"STANDARD-2-8-50\"\n}" response = http.request(request) puts response.read_body ``` ```java Billing_checkResourceEligibility_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"sku_code\": \"STANDARD-2-8-50\"\n}") .asString(); ``` ```php Billing_checkResourceEligibility_example request('POST', 'https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995', [ 'body' => '{ "sku_code": "STANDARD-2-8-50" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Billing_checkResourceEligibility_example using RestSharp; var client = new RestClient("https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"sku_code\": \"STANDARD-2-8-50\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Billing_checkResourceEligibility_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["sku_code": "STANDARD-2-8-50"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=710995")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```