(DEPRECATED) Calculate and return the revenue for a existing or new price plan

POST

revenue_calculator

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

Authorization

string

headerrequired

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

Body

application/json

Request to get revenue details

currencyConfig

object

required

Configuration for getting the currency

pricePlanDetailsConfig

object

required

Configuration for getting the usage rate card

pricePlanDetailsConfig.mode

enum<string>

required

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

Available options:

CUSTOM,

PRICE_PLAN,

ACCOUNT

pricePlanDetailsConfig.pricePlanDetails

object

pricePlanDetailsConfig.pricePlanDetails.supportedCurrencies

string[]

required

List of currencies supported by the price plan

pricePlanDetailsConfig.pricePlanDetails.pricingCycleConfig

object

Represents configurations related to pricing cycle

pricePlanDetailsConfig.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

pricePlanDetailsConfig.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.

pricePlanDetailsConfig.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

pricePlanDetailsConfig.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: 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}

pricePlanDetailsConfig.pricePlanDetails.usageRateCards

object[]

List of usage rate cards

pricePlanDetailsConfig.pricePlanDetails.fixedFeeRateCards

object[]

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards

object[]

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

Maximum length: 50

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.type

enum<string>

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

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

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

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.usageCycle

enum<string>

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

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.enableProration

boolean

required

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.config

object

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.rateValues

object[]

required

pricePlanDetailsConfig.pricePlanDetails.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT,

WALLET

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards

object[]

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.featureId

string

required

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.featureConfigs

object[]

required

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.tag

string

A tag string to group rate cards

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.invoiceTiming

enum<string>

required

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.rateValues

object[]

required

pricePlanDetailsConfig.pricePlanDetails.billingEntitlementRateCards.recurrenceConfig

object

pricePlanDetailsConfig.pricePlanDetails.minimumCommitment

object

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards

object[]

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.id

string

required

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.displayName

string

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.rateDetails

object

required

Amount to be credited

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

pricePlanDetailsConfig.pricePlanDetails.creditGrantRateCards.recurrenceConfig

object

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards

object[]

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

Maximum length: 50

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.tag

string

A tag string to group rate cards

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.maxQuantity

number

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

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetailsConfig.pricePlanDetails.entitlementOverageRateCards.rateValues

object[]

required

pricePlanDetailsConfig.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

pricePlanDetailsConfig.pricePlanDetails.deferredRevenue

boolean

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 deferredRevenue plan
- 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)

pricePlanDetailsConfig.pricePlanDetails.allow_ongoing_cycle_updates

boolean

Allow changes to price plan from the beginning of the ongoing cycle.

pricePlanDetailsConfig.pricePlanId

string

Id of the price plan, this will be considered if mode is PRICE_PLAN

Minimum length: 1

pricePlanDetailsConfig.accountId

string

Id of the account, this will be considered if mode is ACCOUNT

Minimum length: 1

pricePlanDetailsConfig.effectiveOn

string

Will be used for getting the usage rate card, only used if mode is ACCOUNT or PRICE_PLAN

pricePlanDetailsConfig.pricingCycleOrdinal

integer

nth cycle, will be used to calculate revenue for the particular cycle, only used if mode is CUSTOM or PRICE_PLAN

usageConfig

object

required

Configuration for getting the usage

licenseEntriesConfig

object

required

Configuration for getting the license entries

namedLicenseEntriesConfig

object

Configuration for getting the named license entries

prorationConfig

object

Configuration for getting the proration, if not provided no proration will be applied

entitlementOverageConfig

object

Configuration for getting the entitlement overages

Response

200 - application/json

currency

string

required

pricePlanDetails

object

required

pricePlanDetails.supportedCurrencies

string[]

required

pricePlanDetails.activeCurrencies

string[]

required

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.gracePeriod

integer

required

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.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: 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}

pricePlanDetails.usageRateCards

object[]

pricePlanDetails.usageRateCards.displayName

string

Name your rate card, this will be displayed in the Togai App

pricePlanDetails.usageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetails.usageRateCards.tag

string

A tag string to group usageRateCards

pricePlanDetails.usageRateCards.usageMeterId

string

required

pricePlanDetails.usageRateCards.ratePlan

object

required

Contains all rate related configurations

pricePlanDetails.usageRateCards.rateValues

object[]

required

pricePlanDetails.fixedFeeRateCards

object[]

pricePlanDetails.licenseRateCards

object[]

pricePlanDetails.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

Maximum length: 50

pricePlanDetails.licenseRateCards.type

enum<string>

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

pricePlanDetails.licenseRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

pricePlanDetails.licenseRateCards.usageCycle

enum<string>

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

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,

WALLET

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

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

pricePlanDetails.billingEntitlementRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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

Maximum length: 50

pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

pricePlanDetails.entitlementOverageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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.minimumCommitment

object

pricePlanDetails.creditGrantRateCards

object[]

pricePlanDetails.creditGrantRateCards.id

string

required

pricePlanDetails.creditGrantRateCards.displayName

string

pricePlanDetails.creditGrantRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

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

pricePlanDetails.type

enum<string>

Type of price plan

Available options:

BILLING,

PURCHASE

pricePlanDetails.deferredRevenue

boolean

pricePlanDetails.allow_ongoing_cycle_updates

any

Allow changes to price plan from the beginning of the ongoing cycle. type: boolean

revenueInfo

object[]

required

revenueInfo.usageRateCard

object

revenueInfo.fixedFeeRateCard

object

revenueInfo.licenseRateCard

object

revenueInfo.licenseRateCard.id

string

required

Unique Identifier of the attached AddOn

Maximum length: 50

revenueInfo.licenseRateCard.enableProration

boolean

required

revenueInfo.licenseRateCard.ratePlan

object

required

Contains all rate related configurations

revenueInfo.licenseRateCard.rateValues

object[]

required

revenueInfo.licenseRateCard.type

enum<string>

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

revenueInfo.licenseRateCard.displayName

string

Name of the attached AddOn

revenueInfo.licenseRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

revenueInfo.licenseRateCard.tag

string

A tag string to group licenseRateCards

revenueInfo.licenseRateCard.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

revenueInfo.licenseRateCard.usageCycle

enum<string>

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

revenueInfo.licenseRateCard.config

object

revenueInfo.licenseRateCard.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT,

WALLET

revenueInfo.billingEntitlementRateCard

object

Billing Entitlement rate card

revenueInfo.billingEntitlementRateCard.featureId

string

required

revenueInfo.billingEntitlementRateCard.featureConfigs

object[]

required

revenueInfo.billingEntitlementRateCard.invoiceTiming

enum<string>

required

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

revenueInfo.billingEntitlementRateCard.ratePlan

object

required

Contains all rate related configurations

revenueInfo.billingEntitlementRateCard.rateValues

object[]

required

revenueInfo.billingEntitlementRateCard.tag

string

A tag string to group rate cards

revenueInfo.billingEntitlementRateCard.displayName

string

Name your rate card, this will be used in invoice

revenueInfo.billingEntitlementRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

revenueInfo.billingEntitlementRateCard.recurrenceConfig

object

revenueInfo.creditGrantRateCard

object

Credit grant rate card

revenueInfo.creditGrantRateCard.id

string

required

revenueInfo.creditGrantRateCard.grantDetails

object

required

Grant details of Credit Grant Rate Card

revenueInfo.creditGrantRateCard.rateDetails

object

required

Amount to be credited

revenueInfo.creditGrantRateCard.displayName

string

revenueInfo.creditGrantRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

revenueInfo.creditGrantRateCard.tag

string

A tag string to group creditGrantRateCard

revenueInfo.creditGrantRateCard.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

revenueInfo.creditGrantRateCard.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

revenueInfo.creditGrantRateCard.recurrenceConfig

object

revenueInfo.entitlementOverageRateCard

object

revenueInfo.entitlementOverageRateCard.featureId

string

required

Unique Identifier of the attached Feature

Maximum length: 50

revenueInfo.entitlementOverageRateCard.ratePlan

object

required

Contains all rate related configurations

revenueInfo.entitlementOverageRateCard.rateValues

object[]

required

revenueInfo.entitlementOverageRateCard.displayName

string

Name to be displayed during invoice

revenueInfo.entitlementOverageRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

revenueInfo.entitlementOverageRateCard.tag

string

A tag string to group rate cards

revenueInfo.entitlementOverageRateCard.maxQuantity

number

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

revenueInfo.entitlementOverageRateCard.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

revenueInfo.usages

object

required

revenueInfo.fixedFeeRevenueSummary

object

revenueInfo.licenseRevenueSummary

object[]

revenueInfo.billingEntitlementRevenueSummary

object

revenueInfo.creditGrantRevenueSummary

object

revenueInfo.entitlementOverageRevenueSummary

object

revenueInfo.slabRevenueSummaries

object[]

usageLookupRange

object

Start and end dates of usage lookup if usage mode is LOOKUP

Update a setting Get the status of a job

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
      }
    ]
  }
}'

Introduction

APIs

(DEPRECATED) Calculate and return the revenue for a existing or new price plan

Authorizations

Body

Response