usageLimits

Create a usage limit

Requires the USAGE_LIMIT.CREATE permission.

post/v{version}/usage-limits

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/usage-limits
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the usage limit. Changed via the status action, not on create or update.

customer_idstring required

The ID of the customer the usage limit applies to.

meter_value_calculation_idstring required

The ID of the meter value calculation the usage limit is measured against.

scope'SELF' | 'CHILDREN' required

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.

created_atstring nullable
updated_atstring nullable

Response

Created

object_typestring nullable
idstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the usage limit. Changed via the status action, not on create or update.

customer_idstring

The ID of the customer the usage limit applies to.

meter_value_calculation_idstring

The ID of the meter value calculation the usage limit is measured against.

scope'SELF' | 'CHILDREN'

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.

created_atstring nullable
updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.