Skip to main content
POST
/
price_plans
curl --request POST \ --url https://api.togai.com/price_plans \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "grantCheck", "type": "BILLING", "description": "Starter plan", "pricePlanDetails": { "supportedCurrencies": [ "USD" ], "pricingCycleConfig": { "interval": "MONTHLY", "startOffset": { "dayOffset": "1", "monthOffset": "NIL" }, "gracePeriod": 1, "anniversaryCycle": false }, "usageRateCards": [ { "displayName": "rr1", "usageMeterId": "um.20Ms65CtgMy.nwFP0", "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "FLAT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 10, "slabRateConfig": {} } ], "rateConfig": { "minimumRate": "1", "maximumRate": "10" } } ], "tag": "1" } ], "fixedFeeRateCards": [ { "id": "addon.20sidL2HJ7o.vvzDT", "rateValues": [ { "currency": "USD", "rate": 50 } ], "enableProration": false, "displayName": "normal", "tag": "1", "invoiceTiming": "IN_ARREARS", "type": "RECURRING" }, { "id": "addon.20sidQxYRjs.4oBSU", "rateValues": [ { "currency": "USD", "rate": 10 } ], "enableProration": false, "displayName": "anotherNormal", "tag": "2", "invoiceTiming": "IN_ARREARS", "type": "RECURRING" }, { "id": "addon.20sidzySWoa.Bzrcc", "rateValues": [ { "currency": "USD", "rate": 40 } ], "enableProration": false, "displayName": "inadvance", "tag": "1", "invoiceTiming": "IN_ADVANCE", "type": "RECURRING" } ], "licenseRateCards": [ { "id": "addon.20rzlEPp6no.1BYez", "enableProration": false, "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "FLAT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 15, "slabRateConfig": {} } ], "rateConfig": { "minimumRate": "1", "maximumRate": "10" } } ], "displayName": "license", "tag": "2", "config": {} } ], "billingEntitlementRateCards": [ { "featureId": "feature.20jxa18BdUW.d4XQw", "featureConfigs": [ { "featureCreditLimit": 100, "effectiveUntil": "P20D" } ], "invoiceTiming": "IN_ADVANCE", "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "PER_UNIT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 1, "slabRateConfig": {} } ] } ], "displayName": "feature1", "tag": "tag_acme" }, { "featureId": "feature.20uE1xqEudk.MMVH8", "featureConfigs": [ { "featureCreditLimit": 200, "effectiveUntil": "P20D" } ], "invoiceTiming": "IN_ADVANCE", "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "PER_UNIT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 2, "slabRateConfig": {} } ] } ], "displayName": "feature2", "tag": "tag_acme" } ], "minimumCommitment": { "displayName": "Minimum Commitment", "rateValues": [ { "currency": "USD", "rate": 0 } ] }, "creditGrantRateCards": [ { "id": "addon.20ufMNoJoAC.TUzRi", "type": "RECURRING", "displayName": "Credit2", "rateDetails": { "pricingModel": "TIERED", "currencySlabRateDetails": [ { "currency": "USD", "creditAmount": 100, "slabDetails": [ { "startAfter": 0, "priceType": "FLAT", "rate": 10 } ] } ] }, "grantDetails": { "priority": 1, "expiryType": "PRICING_CYCLE", "applicableEntityIds": [] }, "invoiceTiming": "IN_ARREARS", "recurrenceConfig": { "offset": 0, "interval": 1 } }, { "id": "addon.20ufMNoJoAC.TUzRi", "type": "RECURRING", "displayName": "Credit2", "rateDetails": { "pricingModel": "TIERED", "currencySlabRateDetails": [ { "currency": "USD", "slabDetails": [ { "rate": 11, "priceType": "FLAT", "startAfter": 0, "slabConfig": {}, "slabRateConfig": {} } ], "creditAmount": 11 }, { "currency": "INR", "slabDetails": [ { "rate": 11, "priceType": "FLAT", "startAfter": 0, "slabConfig": {}, "slabRateConfig": {} } ], "creditAmount": 11 } ] }, "grantDetails": { "priority": 1, "expiryType": "PRICING_CYCLE", "applicableEntityIds": [] }, "invoiceTiming": "IN_ARREARS", "recurrenceConfig": { "offset": 0, "interval": 1 } } ], "entitlementOverageRateCards": [ { "featureId": "feature.20jxa18BdUW.d4XQw", "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "PER_UNIT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 1, "slabRateConfig": {} } ] } ], "displayName": "feature1", "tag": "tag_acme", "maxQuantity": 50, "billingConfig": { "interval": 1, "startOffset": 4 } }, { "featureId": "feature.20uE1xqEudk.MMVH8", "ratePlan": { "pricingModel": "TIERED", "slabs": [ { "order": 1, "startAfter": 0, "priceType": "PER_UNIT", "slabConfig": {} } ] }, "rateValues": [ { "currency": "USD", "slabRates": [ { "order": 1, "rate": 2, "slabRateConfig": {} } ] } ], "displayName": "feature2", "tag": "tag_acme", "maxQuantity": 50 } ] } } '
{
  "id": "pp.20sieTc1u2i.fY8AT",
  "name": "grantCheck",
  "type": "BILLING",
  "status": "ACTIVE",
  "pricingSchedule": [
    {
      "id": "sch.20sieTcdnQ0.ZmseL",
      "startDate": "1970-01-01T00:00:00Z",
      "endDate": "9999-01-01T00:00:00Z",
      "version": 1,
      "isOverriden": false,
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "1",
            "monthOffset": "NIL"
          },
          "gracePeriod": 1,
          "anniversaryCycle": false
        },
        "usageRateCards": [
          {
            "displayName": "rr1",
            "usageMeterId": "um.20Ms65CtgMy.nwFP0",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 10,
                    "slabRateConfig": {}
                  }
                ]
              }
            ],
            "tag": "1"
          }
        ],
        "fixedFeeRateCards": [
          {
            "id": "addon.20sidL2HJ7o.vvzDT",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 50
              }
            ],
            "enableProration": false,
            "displayName": "normal",
            "tag": "1",
            "invoiceTiming": "IN_ARREARS",
            "type": "RECURRING"
          },
          {
            "id": "addon.20sidQxYRjs.4oBSU",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ],
            "enableProration": false,
            "displayName": "anotherNormal",
            "tag": "2",
            "invoiceTiming": "IN_ARREARS",
            "type": "RECURRING",
            "recurrenceConfig": {
              "interval": 2,
              "offset": 1
            }
          },
          {
            "id": "addon.20sidzySWoa.Bzrcc",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 40
              }
            ],
            "enableProration": false,
            "displayName": "inadvance",
            "tag": "1",
            "invoiceTiming": "IN_ADVANCE",
            "type": "RECURRING"
          }
        ],
        "licenseRateCards": [
          {
            "id": "addon.20darMuJ6C8.bdgRj",
            "enableProration": false,
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 15,
                    "slabRateConfig": {}
                  }
                ]
              }
            ],
            "displayName": "license",
            "tag": "2",
            "config": {
              "maxQuantity": 100
            }
          }
        ],
        "billingEntitlementRateCards": [
          {
            "featureId": "feature.20jxa18BdUW.d4XQw",
            "featureConfigs": [
              {
                "featureCreditLimit": 100,
                "effectiveUntil": "P20D"
              }
            ],
            "invoiceTiming": "IN_ADVANCE",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "PER_UNIT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 1
                  }
                ]
              }
            ],
            "displayName": "feature1"
          },
          {
            "featureId": "feature.20uE1xqEudk.MMVH8",
            "featureConfigs": [
              {
                "featureCreditLimit": 200,
                "effectiveUntil": "P20D"
              }
            ],
            "invoiceTiming": "IN_ADVANCE",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "PER_UNIT",
                  "slabConfig": {}
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 2
                  }
                ]
              }
            ],
            "displayName": "feature2"
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 0
            }
          ]
        },
        "creditGrantRateCards": [
          {
            "id": "addon.20ufMNoJoAC.TUzRi",
            "type": "RECURRING",
            "displayName": "Credit2",
            "rateDetails": {
              "pricingModel": "TIERED",
              "currencySlabRateDetails": [
                {
                  "currency": "USD",
                  "creditAmount": 100,
                  "slabDetails": [
                    {
                      "startAfter": 0,
                      "priceType": "FLAT",
                      "rate": 10
                    }
                  ]
                }
              ]
            },
            "grantDetails": {
              "priority": 1,
              "expiryType": "PRICING_CYCLE",
              "applicableEntityIds": []
            },
            "invoiceTiming": "IN_ARREARS",
            "recurrenceConfig": {
              "offset": 0,
              "interval": 1
            }
          },
          {
            "id": "addon.20ufMNoJoAC.TUzRi",
            "type": "RECURRING",
            "displayName": "Credit2",
            "rateDetails": {
              "pricingModel": "TIERED",
              "currencySlabRateDetails": [
                {
                  "currency": "USD",
                  "slabDetails": [
                    {
                      "rate": 11,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                },
                {
                  "currency": "INR",
                  "slabDetails": [
                    {
                      "rate": 11,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                }
              ]
            },
            "grantDetails": {
              "priority": 1,
              "expiryType": "PRICING_CYCLE",
              "applicableEntityIds": []
            },
            "invoiceTiming": "IN_ARREARS",
            "recurrenceConfig": {
              "offset": 0,
              "interval": 1
            }
          }
        ],
        "type": "BILLING"
      }
    }
  ],
  "description": "Starter plan"
}
Deprecated: This API is deprecated and will be removed in a future release. Please use the Create a price plan V2 API instead for updated functionality.

Authorizations

Authorization
string
header
required

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

Query Parameters

dry_run
boolean
Example:

false

Body

application/json

Payload to create price plan

Request to create a price plan

name
string
required

Name of the price plan

Maximum string length: 50
pricePlanDetails
object
required
description
string

Description of price plan

Maximum string length: 255
type
enum<string>

Type of price plan

Available options:
BILLING,
PURCHASE
pricingRules
object[]

Response

Response for Create and Get price plan requests

Price plan entity

id
string
required

Price plan id

name
string
required

Name of the price plan

Maximum string length: 50
type
enum<string>
required

Type of price plan

Available options:
BILLING,
PURCHASE
status
enum<string>
required

Status of Price plan

Available options:
DRAFT,
ACTIVE,
ARCHIVED
pricingSchedule
object[]
required
description
string

Description of price plan

Maximum string length: 255