curl --request GET \
--url https://api.togai.com/v2/schedules/{schedule_id}/rate_cards \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"billableId": "<string>",
"type": "MINIMUM_COMMITMENT",
"displayName": "<string>",
"invoiceTiming": "IN_ADVANCE",
"rateCardDetails": {
"fixedFeeRateCard": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
],
"enableProration": false,
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"billingEntitlementRateCard": {
"featureId": "<string>",
"featureConfigs": [
{
"effectiveFrom": "<string>",
"effectiveUntil": "<string>",
"featureCreditLimit": 1
}
],
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"displayName": "<string>",
"name": "<string>",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"creditGrantRateCard": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"grantDetails": {
"priority": 1,
"expiryType": "PRICING_CYCLE",
"expiryDuration": "<string>",
"applicableEntityIds": [
"<string>"
]
},
"rateDetails": {
"pricingModel": "TIERED",
"currencySlabRateDetails": [
{
"currency": "<string>",
"creditAmount": 1,
"slabDetails": [
{
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {},
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
]
},
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"usageRateCard": {
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"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": {}
}
]
},
"licenseRateCard": {
"id": "<string>",
"type": "LICENSE",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"usageCycle": "WEEKLY",
"enableProration": false,
"config": {
"maxQuantity": 100,
"maxQuantityBreachAction": "DO_NOTHING"
},
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"proratedRefundMode": "NONE"
},
"entitlementOverageRateCard": {
"featureId": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"maxQuantity": 123,
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"billingConfig": {
"interval": 3,
"startOffset": 5
}
},
"minimumCommitmentRateCard": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
}
},
"tag": "<string>",
"name": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"currencies": [
"<string>"
],
"pricePlanId": "<string>",
"accountId": "<string>"
}
],
"nextToken": "<string>"
}
List rate cards
curl --request GET \
--url https://api.togai.com/v2/schedules/{schedule_id}/rate_cards \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"billableId": "<string>",
"type": "MINIMUM_COMMITMENT",
"displayName": "<string>",
"invoiceTiming": "IN_ADVANCE",
"rateCardDetails": {
"fixedFeeRateCard": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
],
"enableProration": false,
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"billingEntitlementRateCard": {
"featureId": "<string>",
"featureConfigs": [
{
"effectiveFrom": "<string>",
"effectiveUntil": "<string>",
"featureCreditLimit": 1
}
],
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"displayName": "<string>",
"name": "<string>",
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"creditGrantRateCard": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"grantDetails": {
"priority": 1,
"expiryType": "PRICING_CYCLE",
"expiryDuration": "<string>",
"applicableEntityIds": [
"<string>"
]
},
"rateDetails": {
"pricingModel": "TIERED",
"currencySlabRateDetails": [
{
"currency": "<string>",
"creditAmount": 1,
"slabDetails": [
{
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {},
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
]
},
"invoiceTiming": "IN_ADVANCE",
"type": "ONE_TIME",
"recurrenceConfig": {
"interval": 3,
"offset": 5
}
},
"usageRateCard": {
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"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": {}
}
]
},
"licenseRateCard": {
"id": "<string>",
"type": "LICENSE",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"invoiceTiming": "IN_ADVANCE",
"usageCycle": "WEEKLY",
"enableProration": false,
"config": {
"maxQuantity": 100,
"maxQuantityBreachAction": "DO_NOTHING"
},
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"proratedRefundMode": "NONE"
},
"entitlementOverageRateCard": {
"featureId": "<string>",
"displayName": "<string>",
"name": "<string>",
"tag": "<string>",
"maxQuantity": 123,
"ratePlan": {
"pricingModel": "TIERED",
"slabs": [
{
"order": 5,
"startAfter": 123,
"priceType": "FLAT",
"slabConfig": {}
}
]
},
"rateValues": [
{
"currency": "<string>",
"slabRates": [
{
"order": 123,
"rate": 123,
"slabRateConfig": {}
}
],
"rateConfig": {}
}
],
"billingConfig": {
"interval": 3,
"startOffset": 5
}
},
"minimumCommitmentRateCard": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
}
},
"tag": "<string>",
"name": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"currencies": [
"<string>"
],
"pricePlanId": "<string>",
"accountId": "<string>"
}
],
"nextToken": "<string>"
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
"sch.20aUyEZSuYq.SoGbS"
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
10
Possible values:
Response for list rate cards request
Paginated response for rate card