POST
/
v2
/
schedules
/
{schedule_id}
/
rate_cards
curl --request POST \
  --url https://api.togai.com/v2/schedules/{schedule_id}/rate_cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "operations": [
    {
      "actionType": "CREATE",
      "rateCardName": "<string>",
      "rateCard": {
        "billableId": "<string>",
        "type": "MINIMUM_COMMITMENT",
        "displayName": "<string>",
        "invoiceTiming": "IN_ADVANCE",
        "rateCardDetails": {
          "fixedFeeRateCard": {
            "id": "<string>",
            "displayName": "<string>",
            "name": "<string>",
            "tag": "<string>",
            "invoiceTiming": "IN_ADVANCE",
            "type": "ONE_TIME",
            "rateValues": [
              {
                "currency": "<string>",
                "rate": 123
              }
            ],
            "enableProration": false,
            "recurrenceConfig": {
              "interval": 3,
              "offset": 5
            }
          },
          "billingEntitlementRateCard": {
            "featureId": "<string>",
            "featureConfigs": [
              {
                "effectiveFrom": "<string>",
                "effectiveUntil": "<string>",
                "featureCreditLimit": 1
              }
            ],
            "tag": "<string>",
            "invoiceTiming": "IN_ADVANCE",
            "displayName": "<string>",
            "name": "<string>",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 5,
                  "startAfter": 123,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "<string>",
                "slabRates": [
                  {
                    "order": 123,
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ],
            "recurrenceConfig": {
              "interval": 3,
              "offset": 5
            }
          },
          "creditGrantRateCard": {
            "id": "<string>",
            "displayName": "<string>",
            "name": "<string>",
            "tag": "<string>",
            "grantDetails": {
              "priority": 1,
              "expiryType": "PRICING_CYCLE",
              "expiryDuration": "<string>",
              "applicableEntityIds": [
                "<string>"
              ]
            },
            "rateDetails": {
              "pricingModel": "TIERED",
              "currencySlabRateDetails": [
                {
                  "currency": "<string>",
                  "creditAmount": 1,
                  "slabDetails": [
                    {
                      "startAfter": 123,
                      "priceType": "FLAT",
                      "slabConfig": {},
                      "rate": 123,
                      "slabRateConfig": {}
                    }
                  ],
                  "rateConfig": {}
                }
              ]
            },
            "invoiceTiming": "IN_ADVANCE",
            "type": "ONE_TIME",
            "recurrenceConfig": {
              "interval": 3,
              "offset": 5
            }
          },
          "usageRateCard": {
            "displayName": "<string>",
            "name": "<string>",
            "tag": "<string>",
            "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 5,
                  "startAfter": 123,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "<string>",
                "slabRates": [
                  {
                    "order": 123,
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ]
          },
          "licenseRateCard": {
            "id": "<string>",
            "type": "LICENSE",
            "displayName": "<string>",
            "name": "<string>",
            "tag": "<string>",
            "invoiceTiming": "IN_ADVANCE",
            "usageCycle": "WEEKLY",
            "enableProration": false,
            "config": {
              "maxQuantity": 100,
              "maxQuantityBreachAction": "DO_NOTHING"
            },
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 5,
                  "startAfter": 123,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "<string>",
                "slabRates": [
                  {
                    "order": 123,
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ],
            "proratedRefundMode": "NONE"
          },
          "entitlementOverageRateCard": {
            "featureId": "<string>",
            "displayName": "<string>",
            "name": "<string>",
            "tag": "<string>",
            "maxQuantity": 123,
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 5,
                  "startAfter": 123,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "<string>",
                "slabRates": [
                  {
                    "order": 123,
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ],
            "billingConfig": {
              "interval": 3,
              "startOffset": 5
            }
          },
          "minimumCommitmentRateCard": {
            "displayName": "<string>",
            "rateValues": [
              {
                "currency": "<string>",
                "rate": 123
              }
            ]
          }
        },
        "tag": "<string>"
      }
    }
  ]
}'
{
  "rateCards": [
    {
      "billableId": "<string>",
      "type": "MINIMUM_COMMITMENT",
      "displayName": "<string>",
      "invoiceTiming": "IN_ADVANCE",
      "rateCardDetails": {
        "fixedFeeRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ],
          "enableProration": false,
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "billingEntitlementRateCard": {
          "featureId": "<string>",
          "featureConfigs": [
            {
              "effectiveFrom": "<string>",
              "effectiveUntil": "<string>",
              "featureCreditLimit": 1
            }
          ],
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "displayName": "<string>",
          "name": "<string>",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "creditGrantRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "grantDetails": {
            "priority": 1,
            "expiryType": "PRICING_CYCLE",
            "expiryDuration": "<string>",
            "applicableEntityIds": [
              "<string>"
            ]
          },
          "rateDetails": {
            "pricingModel": "TIERED",
            "currencySlabRateDetails": [
              {
                "currency": "<string>",
                "creditAmount": 1,
                "slabDetails": [
                  {
                    "startAfter": 123,
                    "priceType": "FLAT",
                    "slabConfig": {},
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ]
          },
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "usageRateCard": {
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ]
        },
        "licenseRateCard": {
          "id": "<string>",
          "type": "LICENSE",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "usageCycle": "WEEKLY",
          "enableProration": false,
          "config": {
            "maxQuantity": 100,
            "maxQuantityBreachAction": "DO_NOTHING"
          },
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "proratedRefundMode": "NONE"
        },
        "entitlementOverageRateCard": {
          "featureId": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "maxQuantity": 123,
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "billingConfig": {
            "interval": 3,
            "startOffset": 5
          }
        },
        "minimumCommitmentRateCard": {
          "displayName": "<string>",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ]
        }
      },
      "tag": "<string>",
      "name": "<string>",
      "referenceId": "<string>",
      "referenceType": "<string>",
      "currencies": [
        "<string>"
      ],
      "pricePlanId": "<string>",
      "accountId": "<string>"
    }
  ]
}

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

Body

application/json
Payload to bulk rate card operations

Bulk rate card operations for price plan

operations
object[]
required

Response

200
application/json
Response for bulk rate card operations of a price plan

Bulk rate card operations response

rateCards
object[]
required