Update billing rule

patch

https://core-api.ternary.app/api/billing-rules/{ruleID}

Update an existing billing rule. Only the fields included in the request body are modified; omitted fields remain unchanged.

Common updates include changing the rule name, adjusting the effective time range (startTime/endTime), modifying cost filters, updating type-specific meta parameters, or toggling the rule status. The rule type itself cannot be changed after creation.

Path Params

ruleID

uuid

required

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Unique rule ID

Body Params

applyToAllTenants

boolean

When true, the rule applies to all tenants in the organization and applyToTenantIDs must be empty. When false, applyToTenantIDs must contain at least one tenant ID.

applyToTenantIDs

array of uuids

List of tenant IDs the rule applies to. Required and non-empty when applyToAllTenants is false; must be empty when applyToAllTenants is true.

applyToTenantIDs

endTime

date-time | null

Rule end time

name

string

length ≥ 1

Rule name

startTime

date-time

Rule start time

status

string

enum

Rule status. Clients may set ACTIVE, INACTIVE, or DRAFT. PROCESSING and FAILED_PROCESSING are managed by the system.

Allowed:

type

string

enum

Rule type. Must match the rule's current type — the type of an existing rule cannot be changed after creation. Required when meta is provided.

Allowed:

meta

object

Rule-specific configuration. The shape depends on the rule type: ADJUST_TO_LIST uses filters; APPLY_MARGIN and RERATE use adjustToList, filters, metrics, and value; BACKOUT_LINE_ITEM requires filters; REALLOCATE_COSTS uses filters and reallocationConfig.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden