Introduction
APIs
- Authentication
- Customers
- Accounts
- Aliases
- Event Schemas
- Usage Meters
- AddOns
- Licenses
- Feature
- (Deprecated) Price Plans
- Price Plan V2
- Settings
- Price Experimentation
- Jobs
- Event Ingestion
- Entitlements
- Event Management
- Metrics
- Credits
- Invoices
- Payments
- Wallet
- InvoiceGroups
- Alerts
- Reports
(DEPRECATED) Calculate and return the revenue for a existing or new price plan
Calculate and return the revenue for a existing or new price plan
curl --request POST \
--url https://api.togai.com/revenue_calculator \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"currencyConfig": {
"mode": "CUSTOM",
"currency": "USD"
},
"pricePlanDetailsConfig": {
"mode": "PRICE_PLAN",
"pricePlanId": "pp.fdhkf.djf",
"effectiveOn": "2020-01-01T00:00:00Z",
"pricingCycleOrdinal": 1
},
"usageConfig": {
"mode": "CUSTOM",
"usageMap": {
"um.1zcgWalbM2y.qaX5j": 100
}
},
"licenseEntriesConfig": {
"mode": "CUSTOM",
"custom": [
{
"licenseId": "license.1zcgWalbM2y.qaX5j",
"quantity": 10,
"effectiveFrom": "2020-01-01T00:00:00Z"
}
]
},
"entitlementOverageConfig": {
"mode": "CUSTOM",
"custom": [
{
"featureId": "feature.1122.ahoiud",
"quantity": 5
},
{
"featureId": "feature.3452.abcaf2",
"quantity": 28
}
]
}
}'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request to get revenue details
Configuration for getting the currency
Mode to get the currency
- CUSTOM: Use the currency provided in the request
- ACCOUNT_INVOICE: Use the invoice currency of the given account
CUSTOM, ACCOUNT_INVOICE Id of the account of which invoice currency will be used, this will be considered if mode is ACCOUNT_INVOICE
Currency to be used, this will be considered if mode is CUSTOM
1Configuration for getting the license entries
Mode to get the license entries for the license rate cards
- CUSTOM: Use the license entries provided in the request
- LOOKUP_RANGE: Use the license entries of a given account for the specified range
- LOOKUP_CYCLE: Use the license entries of a given account for the specified cycle
CUSTOM, LOOKUP_RANGE, LOOKUP_CYCLE Cycle of license entries to be looked up, this will be considered if mode is LOOKUP_CYCLE
Configuration for getting the usage rate card
Mode to get the usage rate card
- CUSTOM: Use the price plan details provided in the request
- PRICE_PLAN: Use the usage rate cards of the given price plan
- ACCOUNT: Use the usage rate cards of a associated price plan of the given account
CUSTOM, PRICE_PLAN, ACCOUNT Id of the account, this will be considered if mode is ACCOUNT
1Will be used for getting the usage rate card, only used if mode is ACCOUNT or PRICE_PLAN
List of currencies supported by the price plan
Allow changes to price plan from the beginning of the ongoing cycle.
x > 0If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
Name your rate card, this will be used in invoice
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group rate cards
Grant details of Credit Grant Rate Card
Expiry type of grant
PRICING_CYCLE, NO_EXPIRY, CUSTOM x > 0Amount to be credited
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group creditGrantRateCard
Credit grant applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING This option can be enabled while creating a price plan to opt for deferred revenue finalization. i.e, Togai will assume that the price plan may change any time during the pricing cycle and thereby does not compute the revenue in near-real time. This gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle. Enabling this mode comes with the following limitations.
- Following rate cards are not supported under a
deferredRevenueplan- creditGrantRateCards,
- billingEntitlementRateCards,
- entitlementOverageRateCards,
- IN_ADVANCE fixedFeeRateCards,
- IN_ADVANCE licenseRateCards
- Metrics API return revenue metrics only after the grace period of the account's pricing cycle (i.e, only once the invoice becomes DUE)
Unique Identifier of the attached Feature
50Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value
Represents the number of pricing cycles after which the rate card will be billed
Represents the offset for pricing cycles after which the rate card will be billed
Name to be displayed during invoice
Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group rate cards
Unique Identifier of the attached AddOn
50Name of the attached AddOn
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group fixedFeeRateCards
Fixed fee applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Unique Identifier of the attached AddOn
50Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
Max allowed quantity for a particular license in a price plan
Action to be taken when the license maxQuantity is breached:
DO_NOTHING: Refrain from granting any new licenses.
DO_NOTHING Name of the attached AddOn
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
NONE, CREDITS, PAYMENT, WALLET A tag string to group licenseRateCards
LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards
LICENSE, FIXED_FEE, CREDIT_GRANT, NAMED_LICENSE UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY Represents configurations related to pricing cycle
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.
Interval field allow you to define the billing interval you would like to set
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY 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: LAST, 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: LAST, monthOffset: 2}
- 28th Feb - {dayOffset: LAST, monthOffset: 2}
- 15th Aug - {dayOffset: 15, monthOffset: 8}
- 15th Dec - {dayOffset: 15, monthOffset: 12}
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
If interval is WEEKLY, min: "1" and max: "7" as strings. Spl. string allowed: LAST Otherwise, min: "1" and max: "31" as strings. Spl. string allowed: LAST
min: "1" and max: "12". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.
List of usage rate cards
Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
Name your rate card, this will be displayed in the Togai App
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group usageRateCards
Id of the price plan, this will be considered if mode is PRICE_PLAN
1nth cycle, will be used to calculate revenue for the particular cycle, only used if mode is CUSTOM or PRICE_PLAN
Configuration for getting the usage
Mode to get the usage for the usage meters
- CUSTOM: Use the usages provided in the request
- LOOKUP_RANGE: Use the usage of a given account for the specified range
- LOOKUP_CYCLE: Use the usage of a given account for the specified cycle
CUSTOM, LOOKUP_RANGE, LOOKUP_CYCLE Configuration for getting the entitlement overages
Mode to get the entitlement overages for the entitlement overage rate cards
- CUSTOM: Use the entitlement overages provided in the request
- LOOKUP_CYCLE: Use the entitlement overages of a given account for the specified cycle
CUSTOM, LOOKUP_CYCLE Billing cycle of entitlement overages to be looked up, this will be considered if mode is LOOKUP_CYCLE
Configuration for getting the named license entries
Mode to get the named license entries for the license rate cards
- CUSTOM: Use the named license entries provided in the request
- LOOKUP_RANGE: Use the named license entries of a given account for the specified range
- LOOKUP_CYCLE: Use the named license entries of a given account for the specified cycle
CUSTOM, LOOKUP_RANGE, LOOKUP_CYCLE List of named license entries, this will be considered if mode is CUSTOM
Cycle of named license entries to be looked up, this will be considered if mode is LOOKUP_CYCLE
Configuration for getting the proration, if not provided no proration will be applied
Mode to get the proration
- CUSTOM: Use the proration provided in the request
- LOOKUP_CYCLE: Use the proration of a given account for the specified cycle
CUSTOM, LOOKUP_CYCLE Cycle of proration to be looked up, this will be considered if mode is LOOKUP_CYCLE
Response
Allow changes to price plan from the beginning of the ongoing cycle. type: boolean
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Name your rate card, this will be used in invoice
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group rate cards
Grant details of Credit Grant Rate Card
Expiry type of grant
PRICING_CYCLE, NO_EXPIRY, CUSTOM x > 0Amount to be credited
The amount of credit that needs to be credited
x > 0Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group creditGrantRateCard
Credit grant applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Unique Identifier of the attached Feature
50Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value
Represents the number of pricing cycles after which the rate card will be billed
Represents the offset for pricing cycles after which the rate card will be billed
Name to be displayed during invoice
Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group rate cards
Unique Identifier of the attached AddOn
50Name of the attached AddOn
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group fixedFeeRateCards
Fixed fee applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Unique Identifier of the attached AddOn
50Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Max allowed quantity for a particular license in a price plan
Action to be taken when the license maxQuantity is breached:
DO_NOTHING: Refrain from granting any new licenses.
DO_NOTHING Name of the attached AddOn
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
NONE, CREDITS, PAYMENT, WALLET A tag string to group licenseRateCards
LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards
LICENSE, FIXED_FEE, CREDIT_GRANT, NAMED_LICENSE UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY Represents configurations related to pricing cycle
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.
Interval field allow you to define the billing interval you would like to set
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY 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: LAST, 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: LAST, monthOffset: 2}
- 28th Feb - {dayOffset: LAST, monthOffset: 2}
- 15th Aug - {dayOffset: 15, monthOffset: 8}
- 15th Dec - {dayOffset: 15, monthOffset: 12}
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
If interval is WEEKLY, min: "1" and max: "7" as strings. Spl. string allowed: LAST Otherwise, min: "1" and max: "31" as strings. Spl. string allowed: LAST
min: "1" and max: "12". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.
Type of price plan
BILLING, PURCHASE Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Name your rate card, this will be displayed in the Togai App
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group usageRateCards
Billing Entitlement rate card
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Name your rate card, this will be used in invoice
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
Represents the number of pricing cycles after which the rate card will be charged
Represents the offset for pricing cycles after which the rate card will be charged
A tag string to group rate cards
Credit grant rate card
Grant details of Credit Grant Rate Card
Expiry type of grant
PRICING_CYCLE, NO_EXPIRY, CUSTOM x > 0Amount to be credited
The amount of credit that needs to be credited
x > 0Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group creditGrantRateCard
Credit grant applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Unique Identifier of the attached Feature
50Contains all rate related configurations
Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. For more understanding read Rate Cards
TIERED, VOLUME Rate cards can have single or multiple slab up to 100.
1 < x < 10FLAT, PER_UNIT, PACKAGE Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value
Represents the number of pricing cycles after which the rate card will be billed
Represents the offset for pricing cycles after which the rate card will be billed
Name to be displayed during invoice
Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group rate cards
Unique Identifier of the attached AddOn
50Name of the attached AddOn
If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid
IN_ADVANCE, IN_ARREARS, PREPAID Unique identifier for the rate card in a price plan. If left null it is auto-generated.