Update a price plan

PATCH

price_plans

{price_plan_id}

curl --request PATCH \
  --url https://api.togai.com/price_plans/{price_plan_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "updated description",
  "pricePlanDetails": {
    "pricingCycleConfig": {
      "interval": "MONTHLY",
      "startOffset": {
        "dayOffset": "6",
        "monthOffset": "NIL"
      },
      "gracePeriod": 3
    }
  },
  "mode": "IMMEDIATE_IGNORE_OVERRIDE"
}'

{
  "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,
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "1",
            "monthOffset": "NIL"
          },
          "gracePeriod": 1
        },
        "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",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          },
          {
            "id": "addon.20sidQxYRjs.4oBSU",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ],
            "enableProration": false,
            "displayName": "anotherNormal",
            "tag": "2",
            "invoiceTiming": "IN_ARREARS",
            "type": "RECURRING",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          },
          {
            "id": "addon.20sidzySWoa.Bzrcc",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 40
              }
            ],
            "enableProration": false,
            "displayName": "inadvance",
            "tag": "1",
            "invoiceTiming": "IN_ADVANCE",
            "type": "RECURRING",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          }
        ],
        "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": null
            }
          }
        ],
        "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": null
                  }
                ]
              }
            ],
            "displayName": "feature1",
            "tag": null
          },
          {
            "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": null
                  }
                ]
              }
            ],
            "displayName": "feature2",
            "tag": null
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 0
            }
          ]
        },
        "rateDetails": null,
        "entitlementRateCards": null,
        "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,
                      "endAt": null,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                },
                {
                  "currency": "INR",
                  "slabDetails": [
                    {
                      "rate": 11,
                      "endAt": null,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                }
              ]
            },
            "grantDetails": {
              "priority": 1,
              "expiryType": "PRICING_CYCLE",
              "expiryDuration": null,
              "applicableEntityIds": []
            },
            "invoiceTiming": "IN_ARREARS",
            "recurrenceConfig": {
              "offset": 0,
              "interval": 1
            }
          }
        ],
        "type": "BILLING"
      }
    }
  ],
  "description": null
}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

price_plan_id

string

required

Body

application/json

description

string

Description of price plan

pricePlanDetails

object

pricePlanDetails.pricingCycleConfig

object

Represents configurations related to pricing cycle

pricePlanDetails.pricingCycleConfig.interval

enum<string>

required

Interval field allow you to define the billing interval you would like to set

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

pricePlanDetails.pricingCycleConfig.startOffset

object

Represents the start of pricing cycle in terms of

dayOffset - number of days from beginning of week / month and
monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
{dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
{dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
{dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
{dayOffset: 1, monthOffset: NIL} - First day of every month
{dayOffset: 12, monthOffset: NIL} - 12th of every month
{dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
{dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
{dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
{dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
{dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
{dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan
{dayOffset: 15, monthOffset: 1} - 15th Jan
{dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
{dayOffset: 15, monthOffset: 8} - 15th Aug
{dayOffset: 15, monthOffset: LAST} - 15th Dec

pricePlanDetails.pricingCycleConfig.gracePeriod

integer

required

Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.

pricePlanDetails.pricingCycleConfig.anniversaryCycle

boolean

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -

23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
1st Oct - {dayOffset: 1, monthOffset: NIL}
12th Oct - {dayOffset: 12, monthOffset: NIL}
28th Oct - {dayOffset: 28, monthOffset: NIL}
30th Oct - {dayOffset: 30, monthOffset: NIL}
31th Oct - {dayOffset: 31, monthOffset: NIL} QUARTERLY
15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
15th Jan - {dayOffset: 15, monthOffset: 1}
29th Feb on Leap year - {dayOffset: 29, monthOffset: 2}
28th Feb - {dayOffset: 28, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

pricePlanDetails.supportedCurrencies

string[]

pricePlanDetails.usageRateCards

object[]

pricePlanDetails.billingEntitlementRateCards

object[]

pricePlanDetails.billingEntitlementRateCards.featureId

string

required

pricePlanDetails.billingEntitlementRateCards.featureConfigs

object[]

required

pricePlanDetails.billingEntitlementRateCards.tag

string

A tag string to group rate cards

pricePlanDetails.billingEntitlementRateCards.invoiceTiming

enum<string>

required

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

pricePlanDetails.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetails.billingEntitlementRateCards.rateValues

object[]

required

pricePlanDetails.billingEntitlementRateCards.recurrenceConfig

object

pricePlanDetails.entitlementOverageRateCards

object[]

pricePlanDetails.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

pricePlanDetails.entitlementOverageRateCards.tag

string

A tag string to group rate cards

pricePlanDetails.entitlementOverageRateCards.maxQuantity

number

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

pricePlanDetails.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetails.entitlementOverageRateCards.rateValues

object[]

required

pricePlanDetails.entitlementOverageRateCards.billingConfig

object

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

pricePlanDetails.fixedFeeRateCards

object[]

pricePlanDetails.licenseRateCards

object[]

pricePlanDetails.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricePlanDetails.licenseRateCards.enableProration

boolean

required

pricePlanDetails.licenseRateCards.config

object

pricePlanDetails.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetails.licenseRateCards.rateValues

object[]

required

pricePlanDetails.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT

pricePlanDetails.minimumCommitment

object

pricePlanDetails.rateDetails

object

rate details for a price plan

pricePlanDetails.entitlementRateCards

object[]

pricePlanDetails.creditGrantRateCards

object[]

pricePlanDetails.creditGrantRateCards.id

string

required

pricePlanDetails.creditGrantRateCards.displayName

string

pricePlanDetails.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

pricePlanDetails.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

pricePlanDetails.creditGrantRateCards.rateDetails

object

required

Amount to be credited

pricePlanDetails.creditGrantRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricePlanDetails.creditGrantRateCards.type

enum<string>

Credit grant applies either for a one-time occurrence or for each cycle.

Available options:

ONE_TIME,

RECURRING

pricePlanDetails.creditGrantRateCards.recurrenceConfig

object

migrationMode

enum<string>

Available options:

IMMEDIATE,

IMMEDIATE_IGNORE_OVERRIDE,

NEXT_CYCLE,

NEXT_CYCLE_IGNORE_OVERRIDE,

NONE

versionsToMigrate

enum<string>

Available options:

LATEST_VERSION,

ALL_VERSION

Response

200 - application/json

string

required

Price plan id

name

string

required

Name of the price plan

type

enum<string>

required

Type of price plan

Available options:

ENTITLEMENT,

BILLING,

PURCHASE

description

string

Description of price plan

status

enum<string>

required

Status of Price plan

Available options:

DRAFT,

ACTIVE,

ARCHIVED

pricingSchedule

object[]

required

pricingSchedule.id

string

required

pricingSchedule.pricePlanDetails

object

pricingSchedule.pricePlanDetails.supportedCurrencies

string[]

required

pricingSchedule.pricePlanDetails.activeCurrencies

string[]

required

pricingSchedule.pricePlanDetails.pricingCycleConfig

object

Represents configurations related to pricing cycle

pricingSchedule.pricePlanDetails.pricingCycleConfig.interval

enum<string>

required

Interval field allow you to define the billing interval you would like to set

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

pricingSchedule.pricePlanDetails.pricingCycleConfig.startOffset

object

Represents the start of pricing cycle in terms of

dayOffset - number of days from beginning of week / month and
monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
{dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
{dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
{dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
{dayOffset: 1, monthOffset: NIL} - First day of every month
{dayOffset: 12, monthOffset: NIL} - 12th of every month
{dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
{dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
{dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
{dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
{dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
{dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan
{dayOffset: 15, monthOffset: 1} - 15th Jan
{dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
{dayOffset: 15, monthOffset: 8} - 15th Aug
{dayOffset: 15, monthOffset: LAST} - 15th Dec

pricingSchedule.pricePlanDetails.pricingCycleConfig.gracePeriod

integer

required

pricingSchedule.pricePlanDetails.pricingCycleConfig.anniversaryCycle

boolean

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -

23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
1st Oct - {dayOffset: 1, monthOffset: NIL}
12th Oct - {dayOffset: 12, monthOffset: NIL}
28th Oct - {dayOffset: 28, monthOffset: NIL}
30th Oct - {dayOffset: 30, monthOffset: NIL}
31th Oct - {dayOffset: 31, monthOffset: NIL} QUARTERLY
15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
15th Jan - {dayOffset: 15, monthOffset: 1}
29th Feb on Leap year - {dayOffset: 29, monthOffset: 2}
28th Feb - {dayOffset: 28, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

pricingSchedule.pricePlanDetails.usageRateCards

object[]

pricingSchedule.pricePlanDetails.fixedFeeRateCards

object[]

pricingSchedule.pricePlanDetails.licenseRateCards

object[]

pricingSchedule.pricePlanDetails.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

pricingSchedule.pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

pricingSchedule.pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

pricingSchedule.pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricingSchedule.pricePlanDetails.licenseRateCards.enableProration

boolean

required

pricingSchedule.pricePlanDetails.licenseRateCards.config

object

pricingSchedule.pricePlanDetails.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

pricingSchedule.pricePlanDetails.licenseRateCards.rateValues

object[]

required

pricingSchedule.pricePlanDetails.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT

pricingSchedule.pricePlanDetails.billingEntitlementRateCards

object[]

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.featureId

string

required

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.featureConfigs

object[]

required

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.tag

string

A tag string to group rate cards

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.invoiceTiming

enum<string>

required

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.rateValues

object[]

required

pricingSchedule.pricePlanDetails.billingEntitlementRateCards.recurrenceConfig

object

pricingSchedule.pricePlanDetails.entitlementOverageRateCards

object[]

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.tag

string

A tag string to group rate cards

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.maxQuantity

number

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.rateValues

object[]

required

pricingSchedule.pricePlanDetails.entitlementOverageRateCards.billingConfig

object

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

pricingSchedule.pricePlanDetails.minimumCommitment

object

pricingSchedule.pricePlanDetails.rateDetails

object

rate details for a price plan

pricingSchedule.pricePlanDetails.entitlementRateCards

object[]

pricingSchedule.pricePlanDetails.creditGrantRateCards

object[]

pricingSchedule.pricePlanDetails.creditGrantRateCards.id

string

required

pricingSchedule.pricePlanDetails.creditGrantRateCards.displayName

string

pricingSchedule.pricePlanDetails.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

pricingSchedule.pricePlanDetails.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

pricingSchedule.pricePlanDetails.creditGrantRateCards.rateDetails

object

required

Amount to be credited

pricingSchedule.pricePlanDetails.creditGrantRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

pricingSchedule.pricePlanDetails.creditGrantRateCards.type

enum<string>

Credit grant applies either for a one-time occurrence or for each cycle.

Available options:

ONE_TIME,

RECURRING

pricingSchedule.pricePlanDetails.creditGrantRateCards.recurrenceConfig

object

pricingSchedule.pricePlanDetails.type

enum<string>

Type of price plan

Available options:

ENTITLEMENT,

BILLING,

PURCHASE

pricingSchedule.startDate

string

required

pricingSchedule.endDate

string

required

pricingSchedule.version

integer

required

Get a price plan Activate a price plan

curl --request PATCH \
  --url https://api.togai.com/price_plans/{price_plan_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "updated description",
  "pricePlanDetails": {
    "pricingCycleConfig": {
      "interval": "MONTHLY",
      "startOffset": {
        "dayOffset": "6",
        "monthOffset": "NIL"
      },
      "gracePeriod": 3
    }
  },
  "mode": "IMMEDIATE_IGNORE_OVERRIDE"
}'

{
  "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,
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "1",
            "monthOffset": "NIL"
          },
          "gracePeriod": 1
        },
        "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",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          },
          {
            "id": "addon.20sidQxYRjs.4oBSU",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ],
            "enableProration": false,
            "displayName": "anotherNormal",
            "tag": "2",
            "invoiceTiming": "IN_ARREARS",
            "type": "RECURRING",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          },
          {
            "id": "addon.20sidzySWoa.Bzrcc",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 40
              }
            ],
            "enableProration": false,
            "displayName": "inadvance",
            "tag": "1",
            "invoiceTiming": "IN_ADVANCE",
            "type": "RECURRING",
            "recurrenceConfig": {
              "interval": null,
              "offset": null
            }
          }
        ],
        "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": null
            }
          }
        ],
        "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": null
                  }
                ]
              }
            ],
            "displayName": "feature1",
            "tag": null
          },
          {
            "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": null
                  }
                ]
              }
            ],
            "displayName": "feature2",
            "tag": null
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 0
            }
          ]
        },
        "rateDetails": null,
        "entitlementRateCards": null,
        "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,
                      "endAt": null,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                },
                {
                  "currency": "INR",
                  "slabDetails": [
                    {
                      "rate": 11,
                      "endAt": null,
                      "priceType": "FLAT",
                      "startAfter": 0,
                      "slabConfig": {},
                      "slabRateConfig": {}
                    }
                  ],
                  "creditAmount": 11
                }
              ]
            },
            "grantDetails": {
              "priority": 1,
              "expiryType": "PRICING_CYCLE",
              "expiryDuration": null,
              "applicableEntityIds": []
            },
            "invoiceTiming": "IN_ARREARS",
            "recurrenceConfig": {
              "offset": 0,
              "interval": 1
            }
          }
        ],
        "type": "BILLING"
      }
    }
  ],
  "description": null
}

Introduction

APIs

Authorizations

Path Parameters

Body

Response