Get the current usage-limit status for a customer | Solvimon

{
  "data": [
    {
      "customer_id": "string",
      "meter_value_calculation_id": "string",
      "scope": "string",
      "limit": {
        "number": "string",
        "amount": {
          "quantity": "string",
          "currency": "AED"
        },
        "credits": {
          "quantity": "string",
          "credit_type_id": "string"
        }
      },
      "consumed": {
        "number": "string",
        "amount": {
          "quantity": "string",
          "currency": "AED"
        },
        "credits": {
          "quantity": "string",
          "credit_type_id": "string"
        }
      },
      "percentage": "string"
    }
  ],
  "period_start": "string",
  "period_end": "string"
}

Requires the USAGE_LIMIT.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

customer_idstringRequired

The resource id of the customer to report usage-limit status for.

include_childrenbooleanOptional

Whether to also report the status of each direct sub-customer.

Response

datalist of objects or nullOptionalRead-only

The per-metric usage-limit status entries.

period_startstring or nullOptionalRead-only

The start of the billing period the consumed values are measured over.

period_endstring or nullOptionalRead-only

The end of the billing period the consumed values are measured over.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -G https://test.api.solvimon.com/v1/usage-limits/status \
>	-H "X-API-KEY: <apiKey>" \
>	-d customer_id=customer_id

Authentication

Path parameters

Headers

Query parameters

Response

Errors