Check resource billing eligibility | ibee

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.

Authentication

AuthorizationBearer

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.

Query parameters

workspace_idstringRequired

The workspace ID to scope this request to.

Request

This endpoint expects an object.

sku_codestringOptional1-64 characters

Billing catalog SKU for the intended resource. Unknown or unavailable SKUs may be denied.

estimated_cost_minorintegerOptional>=0

Optional estimated cost expressed in the organization's currency minor unit. Use a value from a trusted catalog.

Response

Billing eligibility decision returned successfully.

organization_idstring

allowedboolean

Continue only when this value is exactly true.

reasonstring

Machine-readable decision reason.

billing_modeenum

billing_stateenum

currencystring

evaluated_atdatetime

sku_codestring or nullOptional

estimated_cost_minorinteger or nullOptional

effective_balance_minorinteger or nullOptional

credit_headroom_minorinteger or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

502

Bad Gateway Error

504

Gateway Timeout Error

$	curl -X POST "https://api.ibee.co.in/v1/billing/resource-eligibility?workspace_id=workspace_id" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"sku_code": "STANDARD-2-8-50"
>	}'

1	{
2	"organization_id": "string",
3	"allowed": true,
4	"reason": "sufficient_balance",
5	"billing_mode": "PREPAID",
6	"billing_state": "CURRENT",
7	"currency": "INR",
8	"evaluated_at": "2024-01-15T09:30:00Z",
9	"sku_code": "string",
10	"estimated_cost_minor": 1,
11	"effective_balance_minor": 1,
12	"credit_headroom_minor": 1
13	}