Update pricing rules of a account schedule

curl --request PUT \
  --url https://api.togai.com/v2/schedules/{schedule_id}/pricing_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pricingRules": [
    {
      "name": "<string>",
      "order": 123,
      "computation": "<string>",
      "action": {
        "type": "ADD",
        "target": "<string>",
        "id": "<string>",
        "description": "<string>",
        "metadata": {}
      },
      "invoiceTiming": "IN_ADVANCE",
      "condition": "<string>"
    }
  ]
}
'

{
  "data": [
    {
      "id": "um.1zYnCiM9Bpg.lv25y",
      "name": "Rule 1",
      "version": 1,
      "order": 1,
      "computation": "{\"+\": [{\"var\": \"revenue.urc.um.21lmjsfcXPs.d929R\"}, {\"var\": \"usage.urc.um.21lmjObpMV6.9XeFl\"}]}\n",
      "condition": "{\">\": [{\"+\": [{\"var\": \"revenue.urc.um.21lmjObpMV6.9XeFl\"}, {\"var\": \"usage.urc.um.21lmjObpMV6.9XeFl\"}]}, 100]}\n",
      "action": {
        "type": "UPDATE",
        "target": "revenue.ff.addon.21ERXMFJ83s.9EM5S"
      }
    }
  ]
}

PUT

schedules

{schedule_id}

pricing_rules

Update pricing rules of a account schedule

curl --request PUT \
  --url https://api.togai.com/v2/schedules/{schedule_id}/pricing_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pricingRules": [
    {
      "name": "<string>",
      "order": 123,
      "computation": "<string>",
      "action": {
        "type": "ADD",
        "target": "<string>",
        "id": "<string>",
        "description": "<string>",
        "metadata": {}
      },
      "invoiceTiming": "IN_ADVANCE",
      "condition": "<string>"
    }
  ]
}
'

{
  "data": [
    {
      "id": "um.1zYnCiM9Bpg.lv25y",
      "name": "Rule 1",
      "version": 1,
      "order": 1,
      "computation": "{\"+\": [{\"var\": \"revenue.urc.um.21lmjsfcXPs.d929R\"}, {\"var\": \"usage.urc.um.21lmjObpMV6.9XeFl\"}]}\n",
      "condition": "{\">\": [{\"+\": [{\"var\": \"revenue.urc.um.21lmjObpMV6.9XeFl\"}, {\"var\": \"usage.urc.um.21lmjObpMV6.9XeFl\"}]}, 100]}\n",
      "action": {
        "type": "UPDATE",
        "target": "revenue.ff.addon.21ERXMFJ83s.9EM5S"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

schedule_id

string

required

Example:

"sch.20aUyEZSuYq.SoGbS"

Body

application/json

Payload to update pricing rules

pricingRules

object[]

Show child attributes

pricingRules.name

string

required

Name of the pricing rule

pricingRules.order

integer<int32>

required

Order of the pricing rule

pricingRules.computation

string

required

JSON logic to be computed

pricingRules.action

object

required

Show child attributes

pricingRules.action.type

enum<string>

required

Available options:

ADD,

UPDATE

pricingRules.action.target

string

pricingRules.action.id

string

pricingRules.action.description

string

pricingRules.action.metadata

object

Show child attributes

pricingRules.action.metadata.{key}

string

pricingRules.invoiceTiming

enum<string>

If IN_ADVANCE, the rule will be applied on rate cards with invoice timing IN_ADVANCE . If IN_ARREARS, the rule will be applied on rate cards with invoice timing IN_ARREARS .

Available options:

IN_ADVANCE,

IN_ARREARS

pricingRules.condition

string

JSON logic condition deciding whether to compute this pricing rule or not

Response

200 - application/json

Response for create/list pricing rules request

data

object[]

required

Show child attributes

data.id

string

required

data.name

string

required

data.version

integer<int32>

required

Required range: x >= 1

data.order

integer<int32>

required

Required range: x >= 1

data.computation

string

required

JSON logic to be computed

data.action

action · object

required

JSON logic to be computed

Show child attributes

data.action.type

enum<string>

required

Available options:

ADD,

UPDATE

data.action.target

string

data.action.id

string

data.action.description

string

data.action.metadata

object

Show child attributes

data.action.metadata.{key}

string

data.invoiceTiming

enum<string>

If IN_ADVANCE, the rule will be applied on rate cards with invoice timing IN_ADVANCE . If IN_ARREARS, the rule will be applied on rate cards with invoice timing IN_ARREARS .

Available options:

IN_ADVANCE,

IN_ARREARS

data.condition

string

JSON logic condition deciding whether to compute this pricing rule or not

List pricing rules of a account schedule List all aliases

⌘I

Introduction

APIs

Update pricing rules of a account schedule

Authorizations

Path Parameters

Body

Response