Introduction
APIs
- GETList price plans
- POSTCreate a price plan
- GETGet a price plan
- PATCHUpdate a price plan
- DELDiscard a price plan
- POSTFinalize a price plan
- GETList rate cards of a price plan
- POSTBulk rate card operations of a price plan
- GETList pricing rules of a price plan
- PUTUpdate pricing rules of a price plan
- GETGet list of errors of a price plan
- GETList price plan versions
- POSTCreate a price plan v2 migration
- GET
curl --request GET \
--url https://api.togai.com/v2/price_plans/{price_plan_id}/rate_cards \
--header 'Authorization: Bearer <token>'{
"data": [
{
"billableId": "<string>",
"type": "MINIMUM_COMMITMENT",
"displayName": "<string>",
"invoiceTiming": "IN_ADVANCE",
"rateCardDetails": {
"fixedFeeRateCard": {
"id": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
],
"enableProration": false,
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"billingEntitlementRateCard": {
"featureId": "<string>",
"featureConfigs": [
{
"effectiveUntil": "<string>",
"featureCreditLimit": 1,
"effectiveFrom": "<string>"
}
],
"invoiceTiming": "IN_ADVANCE",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"tag": "<string>",
"displayName": "<string>",
"name": "<string>",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"creditGrantRateCard": {
"id": "<string>",
"grantDetails": {
"priority": 1,
"expiryType": "PRICING_CYCLE",
"expiryDuration": "<string>",
"applicableEntityIds": [
"<string>"
]
},
"rateDetails": {
"pricingModel": "TIERED",
"currencySlabRateDetails": [
{
"currency": "<string>",
"creditAmount": 1,
"slabDetails": [
{
"startAfter": 123,
"priceType": "FLAT",
"rate": 123,
"slabConfig": {},
"slabRateConfig": {}
}
],
"rateConfig": {}
}
]
},
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"usageRateCard": {
"usageMeterId": "um.1zYnCiM9Bpg.1zYn",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"displayName": "<string>",
"name": "<string>",
"tag": "<string>"
},
"licenseRateCard": {
"id": "<string>",
"enableProration": false,
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"type": "LICENSE",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"usageCycle": "WEEKLY",
"config": {
"maxQuantity": 100,
"maxQuantityBreachAction": "DO_NOTHING"
},
"proratedRefundMode": "NONE"
},
"entitlementOverageRateCard": {
"featureId": "<string>",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"maxQuantity": 123,
"billingConfig": {
"interval": 3,
"startOffset": 5
}
},
"minimumCommitmentRateCard": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
}
},
"name": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"pricePlanId": "<string>",
"tag": "<string>",
"currencies": [
"<string>"
],
"accountId": "<string>"
}
],
"nextToken": "<string>"
}List rate cards of a price plan
List rate cards of a price plan
curl --request GET \
--url https://api.togai.com/v2/price_plans/{price_plan_id}/rate_cards \
--header 'Authorization: Bearer <token>'{
"data": [
{
"billableId": "<string>",
"type": "MINIMUM_COMMITMENT",
"displayName": "<string>",
"invoiceTiming": "IN_ADVANCE",
"rateCardDetails": {
"fixedFeeRateCard": {
"id": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
],
"enableProration": false,
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"billingEntitlementRateCard": {
"featureId": "<string>",
"featureConfigs": [
{
"effectiveUntil": "<string>",
"featureCreditLimit": 1,
"effectiveFrom": "<string>"
}
],
"invoiceTiming": "IN_ADVANCE",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"tag": "<string>",
"displayName": "<string>",
"name": "<string>",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"creditGrantRateCard": {
"id": "<string>",
"grantDetails": {
"priority": 1,
"expiryType": "PRICING_CYCLE",
"expiryDuration": "<string>",
"applicableEntityIds": [
"<string>"
]
},
"rateDetails": {
"pricingModel": "TIERED",
"currencySlabRateDetails": [
{
"currency": "<string>",
"creditAmount": 1,
"slabDetails": [
{
"startAfter": 123,
"priceType": "FLAT",
"rate": 123,
"slabConfig": {},
"slabRateConfig": {}
}
],
"rateConfig": {}
}
]
},
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"usageRateCard": {
"usageMeterId": "um.1zYnCiM9Bpg.1zYn",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"displayName": "<string>",
"name": "<string>",
"tag": "<string>"
},
"licenseRateCard": {
"id": "<string>",
"enableProration": false,
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"type": "LICENSE",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"usageCycle": "WEEKLY",
"config": {
"maxQuantity": 100,
"maxQuantityBreachAction": "DO_NOTHING"
},
"proratedRefundMode": "NONE"
},
"entitlementOverageRateCard": {
"featureId": "<string>",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"maxQuantity": 123,
"billingConfig": {
"interval": 3,
"startOffset": 5
}
},
"minimumCommitmentRateCard": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
}
},
"name": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"pricePlanId": "<string>",
"tag": "<string>",
"currencies": [
"<string>"
],
"accountId": "<string>"
}
],
"nextToken": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
50"pp.1zYnCiM9Bpg.lv25y"
Query Parameters
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
10
Response
Response for list rate cards request
Paginated response for rate card
Show child attributes
Show child attributes
Billable identifier
50Rate card type
MINIMUM_COMMITMENT, BILLING_ENTITLEMENT, CREDIT_GRANT, ENTITLEMENT_OVERAGE, FIXED_FEE, LICENSE, USAGE Display name of the rate card Display name of the rate card
255If 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 Rate card details
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique Identifier of the attached AddOn
50false
Name of the attached AddOn
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group fixedFeeRateCards
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 Fixed fee applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Show child attributes
Show child attributes
Represents the number of pricing cycles after which the rate card will be charged
3
Represents the offset for pricing cycles after which the rate card will be charged
5
Billing Entitlement rate card
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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.
1Show child attributes
Show child attributes
1 <= x <= 10FLAT, PER_UNIT, PACKAGE Show child attributes
Show child attributes
1Show child attributes
Show child attributes
A tag string to group rate cards
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.
Show child attributes
Show child attributes
Represents the number of pricing cycles after which the rate card will be charged
3
Represents the offset for pricing cycles after which the rate card will be charged
5
Credit grant rate card
Show child attributes
Show child attributes
Grant details of Credit Grant Rate Card
Show child attributes
Show child attributes
x >= 0Expiry type of grant
PRICING_CYCLE, NO_EXPIRY, CUSTOM Amount to be credited
Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
The amount of credit that needs to be credited
x >= 0Show child attributes
Show child attributes
FLAT, PER_UNIT, PACKAGE Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group creditGrantRateCard
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 Credit grant applies either for a one-time occurrence or for each cycle.
ONE_TIME, RECURRING Show child attributes
Show child attributes
Represents the number of pricing cycles after which the rate card will be charged
3
Represents the offset for pricing cycles after which the rate card will be charged
5
Show child attributes
Show child attributes
"um.1zYnCiM9Bpg.1zYn"
Contains all rate related configurations
Show child attributes
Show child attributes
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.
1Show child attributes
Show child attributes
1 <= x <= 10FLAT, PER_UNIT, PACKAGE Show child attributes
Show child attributes
1Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Unique Identifier of the attached AddOn
50false
Contains all rate related configurations
Show child attributes
Show child attributes
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.
1Show child attributes
Show child attributes
1 <= x <= 10FLAT, PER_UNIT, PACKAGE Show child attributes
Show child attributes
1Show child attributes
Show child attributes
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 Name of the attached AddOn
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group licenseRateCards
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 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 Show child attributes
Show child attributes
Max allowed quantity for a particular license in a price plan
100
Action to be taken when the license maxQuantity is breached:
DO_NOTHING: Refrain from granting any new licenses.
DO_NOTHING NONE, CREDITS, PAYMENT, WALLET Show child attributes
Show child attributes
Unique Identifier of the attached Feature
50Contains all rate related configurations
Show child attributes
Show child attributes
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.
1Show child attributes
Show child attributes
1 <= x <= 10FLAT, PER_UNIT, PACKAGE Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Name to be displayed during invoice
Unique identifier for the rate card in a price plan. If left null it is auto-generated.
A tag string to group rate cards
Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed
Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value
Show child attributes
Show child attributes
Represents the number of pricing cycles after which the rate card will be billed
3
Represents the offset for pricing cycles after which the rate card will be billed
5
Show child attributes
Show child attributes
505050Price plan identifier
50Tag for rate card
50List of currencies supported by the rate card
Account identifier