Skip to main content

Credit allocation rule

GET 
/license/api/v1/credit-allocation-rule/:ruleId

Get a credit allocation rule, without license usage

Request​

Path Parameters

    ruleId stringrequired

Responses​

Success

Schema
    id stringrequired

    Unique id. Ignored on create. Must match path param on update.

    customerId int32

    Customer id. Ignored on create and update.

    prismaId int64

    Customer prisma id. Ignored on create and update.

    name stringrequired

    Possible values: non-empty and <= 200 characters

    Rule name. Must be non-empty and unique. Required on create. Ignored on update if null.

    targetType stringrequired

    Possible values: [AccountGroup]

    Must be 'AccountGroup'. Required on create. Ignored on update if null.

    allocatedCredits int32required

    Possible values: <= 2147483647

    Credits allocated to this rule. Required on create. Ignored on update if null.

    alarmThreshold int32required

    Possible values: <= 100

    Percent usage of allocatedCredits to trigger alarm. Required on create. Ignored on update if null.

    accountGroups string[]required

    Possible values: >= 1, <= 2147483647

    Account group ids. Must be at least one. Required on create. Ignored on update if null.

    usedCredits int32

    Credit usage for the requested time period

    percentage int32

    Percent credit usage of the rule allocated credits

Loading...