Consume

Try to consume quota based on the provided request details.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Data Transfer Object (DTO) for requesting quota consumption.

userIdstring · nullableOptional

The ID of the user requesting quota consumption. This identifies who is making the request.

featureCodestring · min: 1Required

The code of the feature for which quota is being consumed.

amountinteger · int64Optional

The amount of quota to consume. By default, this is set to 1.

resourcestring · nullableOptional

The resource associated with the quota consumption. This could be a specific item or entity related to the consumption.

sourcestring · nullableOptional

The source of the quota consumption request. This could indicate where the request originated from.

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/quota-usages/consume

HTTPcURLJavaScriptPython

POST /api/v1/quota-usages/consume HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "userId": "text",
  "featureCode": "text",
  "amount": 1,
  "resource": "text",
  "source": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "feature": {
      "type": "Function",
      "title": "Feature Title",
      "value": 10,
      "isUnlimited": false,
      "resetPolicy": 0,
      "customIntervalDays": null,
      "id": "sApKpllz4sAplsmzha",
      "parentBrandId": "Brand_ID",
      "eventId": "Event_ID",
      "code": "Code",
      "name": "Feature Name",
      "unit": "Unit",
      "defaultValue": null,
      "helpURL": null,
      "image": "https://www.example.com/image.jpg",
      "styles": "{\"color\": \"red\"}",
      "description": "Feature Description",
      "tags": "#Tag1, #Tag2",
      "zOrder": 1,
      "status": "Active"
    },
    "usedAmount": 1000,
    "limitAmount": 5000,
    "remainingAmount": 4000,
    "isUnlimited": false,
    "periodKey": "202509",
    "periodStartDate": "2026-01-26T01:03:23.881063Z",
    "periodEndDate": "2026-02-26T01:03:23.881063Z",
    "status": "Normal",
    "modifiedDate": "2026-01-26T01:03:23.881063Z",
    "id": "sApKpllz4sAplsmzha",
    "createdDate": "2026-01-26T01:03:23.881061Z"
  },
  "errors": []
}