Configuration APIUsage Limits

Delete a usage limit

Requires the USAGE_LIMIT.DELETE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
statusenum or nullOptionalRead-only
The status of the usage limit. Changed via the status action, not on create or update.
customer_idstringOptional
The ID of the customer the usage limit applies to.
meter_value_calculation_idstringOptional
The ID of the meter value calculation the usage limit is measured against.
scopeenumOptional

Whether the limit applies to the customer itself (SELF) or is the default for each of its children (CHILDREN). A SELF limit covers usage billed on the customer’s own subscription; children with a subscription of their own are not included - give those their own limits.

limitobjectOptional

The limit value, exactly one of number, amount, or credits, in the same dimension as the metric’s meter value (number or credits for a NUMBER meter value, amount for an AMOUNT meter value). Amounts are compared without currency conversion.

created_atstring or nullOptionalRead-only
updated_atstring or nullOptionalRead-only

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error