Introduction
curl --request GET \
--url https://api.togai.com/accounts/{account_id}/purchases \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"status": "SUCCESS",
"createdAt": "2023-11-07T05:31:56Z",
"type": "ENTITLEMENT_GRANT",
"pricePlanId": "<string>",
"pricePlanName": "<string>",
"quantity": 123,
"rateCardQuantities": {},
"pricePlanVersion": 123,
"idempotencyKey": "<string>",
"purchasePlan": {
"supportedCurrencies": [
"<string>"
],
"activeCurrencies": [
"<string>"
],
"pricingCycleConfig": {
"interval": "WEEKLY",
"gracePeriod": 3,
"startOffset": {
"dayOffset": "<string>",
"monthOffset": "<string>"
},
"anniversaryCycle": true
},
"usageRateCards": [
{
"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>"
}
],
"fixedFeeRateCards": [
{
"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
}
}
],
"licenseRateCards": [
{
"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"
}
],
"billingEntitlementRateCards": [
{
"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
}
}
],
"entitlementOverageRateCards": [
{
"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
}
}
],
"minimumCommitment": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
},
"creditGrantRateCards": [
{
"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
}
}
],
"type": "BILLING",
"deferredRevenue": true,
"allow_ongoing_cycle_updates": "<unknown>"
},
"walletTopupDetails": {
"topupAmount": 123,
"purchaseAmount": 123
},
"price": 123,
"invoiceCurrency": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"nextToken": "<string>",
"context": {
"pageSize": 123,
"sortOrder": "ASC"
}
}(DEPRECATED) Get all purchases for an account
Get Purchase information for an account using account_id and price_plan_id
curl --request GET \
--url https://api.togai.com/accounts/{account_id}/purchases \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"status": "SUCCESS",
"createdAt": "2023-11-07T05:31:56Z",
"type": "ENTITLEMENT_GRANT",
"pricePlanId": "<string>",
"pricePlanName": "<string>",
"quantity": 123,
"rateCardQuantities": {},
"pricePlanVersion": 123,
"idempotencyKey": "<string>",
"purchasePlan": {
"supportedCurrencies": [
"<string>"
],
"activeCurrencies": [
"<string>"
],
"pricingCycleConfig": {
"interval": "WEEKLY",
"gracePeriod": 3,
"startOffset": {
"dayOffset": "<string>",
"monthOffset": "<string>"
},
"anniversaryCycle": true
},
"usageRateCards": [
{
"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>"
}
],
"fixedFeeRateCards": [
{
"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
}
}
],
"licenseRateCards": [
{
"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"
}
],
"billingEntitlementRateCards": [
{
"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
}
}
],
"entitlementOverageRateCards": [
{
"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
}
}
],
"minimumCommitment": {
"displayName": "<string>",
"rateValues": [
{
"currency": "<string>",
"rate": 123
}
]
},
"creditGrantRateCards": [
{
"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
}
}
],
"type": "BILLING",
"deferredRevenue": true,
"allow_ongoing_cycle_updates": "<unknown>"
},
"walletTopupDetails": {
"topupAmount": 123,
"purchaseAmount": 123
},
"price": 123,
"invoiceCurrency": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"nextToken": "<string>",
"context": {
"pageSize": 123,
"sortOrder": "ASC"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
account_id corresponding to an account
50"ACC00001"
Response
Response for list Purchase for an account request
Show child attributes
Show child attributes
Status of the purchase
SUCCESS, FAILURE, PENDING, IN_PROGRESS, PROPOSAL_ACTIVE, PROPOSAL_APPROVED, PROPOSAL_DECLINED, PROPOSAL_EXPIRED Specifies whether this purchase is for granting entitlements or for an association or for wallet topup or prepaid purchase. If left null, ENTITLEMENT_GRANT is taken as default
ENTITLEMENT_GRANT, ASSOCIATION, WALLET_TOPUP, PREPAID Show child attributes
Show child attributes
Represents configurations related to pricing cycle
Show child attributes
Show child attributes
Interval field allow you to define the billing interval you would like to set
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY 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.
3
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
Show child attributes
Show child attributes
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.
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}
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
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
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
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
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
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
Type of price plan
BILLING, PURCHASE Allow changes to price plan from the beginning of the ongoing cycle. type: boolean
Information related to wallet topup purchase
Show child attributes
Show child attributes