Togai Accounts API is one of 25 APIs that Togai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.
This API exposes
18 operations
across 13 paths,
and defines 81 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://api.togai.com/, https://sandbox-api.togai.com/.
The identity and technical contract details declared by the specification.
CreditRateDetails
object
Amount to be credited
2 properties
2 required
EntitlementOverageRateCard
object
7 properties
3 required
PurchaseType
string
Specifies whether this purchase is for granting entitlements or for an association or for wallet topup or prepaid purchase. If left null, ENTITLEMENTGRANT is t…
PricingRuleTiming
string
If INADVANCE, the rule will be applied on rate cards with invoice timing INADVANCE . If INARREARS, the rule will be applied on rate cards with invoice timing I…
SlabDetail
object
The details of a slab
5 properties
3 required
PurchasePlanOverride
object
entitlements override options for purchase of a price plan for an account
3 properties
Address
object
billing address of the customer
7 properties
InvoiceTiming
string
If INADVANCE, the rate card will be invoiced in the previous billing cycle. If INARREARS, the rate card will be invoiced in the current billing cycle. If PREPA…
MinimumCommitment
object
2 properties
2 required
CreatePricePlanDetailsOverride
object
9 properties
ExpiryType
string
Expiry type of grant
PricingRule
object
Represents pricing rules of a price plan. i.e, price plan bound by time.
8 properties
6 required
SlabRate
object
Represents a rate for a slab
3 properties
2 required
Slab
object
Represents a pricing priceType (rates + slabs) for usage price plan
4 properties
3 required
PreAction
object
Pre action to be performed before association or disassociation
2 properties
1 required
Account
object
Structure of an account
15 properties
6 required
UpdatePricingScheduleResponse
object
3 properties
3 required
ProratedRefundMode
string
CreateAccountRequestWithoutCustomerId
object
Payload to create account
12 properties
2 required
RemoveAccountAliasesRequest
object
Payload to remove account aliases
2 properties
PlanOverride
object
Represents effectiveness period and config of a price plan. i.e, price plan bound by time.
7 properties
5 required
PricePlanType
string
Type of price plan
CreditGrantRateCard
object
Credit grant rate card
8 properties
3 required
ProposalsListResponse
object
Represents a Proposal for List Response
12 properties
6 required
RateValue
object
Represents a rate
3 properties
2 required
WalletTopupDetails
object
Information related to wallet topup purchase
2 properties
1 required
UpdatePricingScheduleRequest
object
7 properties
2 required
FixedFeeRateCard
object
8 properties
3 required
Purchase
object
Represents a Purchase
21 properties
5 required
ProposalsPaginatedResponse
object
3 properties
PaginationOptions
object
2 properties
RatePlan
object
Contains all rate related configurations
2 properties
2 required
UsageCycleInterval
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 the…
InvoiceGroupDetails
object
Invoice group details
7 properties
6 required
FeatureConfig
object
Feature configuration object
3 properties
2 required
BaseSuccessResponse
object
1 property
1 required
CreatePurchaseRequest
object
Create a purchase for an account
11 properties
PricingSchedule
object
Represents effectiveness period and config of a price plan. i.e, price plan bound by time.
7 properties
5 required
CreateEntitySetting
object
Represents a setting
5 properties
5 required
FixedFeeType
string
Fixed fee applies either for a one-time occurrence or for each cycle.
RecurrenceConfig
object
2 properties
PricingRuleAction
object
5 properties
1 required
PurchaseStatus
string
Status of the purchase
PricingScheduleWithPricePlanId
UsageRateCard
object
5 properties
3 required
ErrorResponse
object
1 property
1 required
LicenseRateCardConfig
object
2 properties
CreditGrantType
string
Credit grant applies either for a one-time occurrence or for each cycle.
PricePlanDetails
object
12 properties
2 required
AddOnType
string
LICENSE: Addon can be used in license rate cards FIXEDFEE: Addon can be used in fixed fee rate cards CREDITGRANT: Addon can be used in credit grant rate cards…
EditPricingScheduleRequest
object
Request to dis/associate one or more schedules to an account
1 property
1 required
PurchasePaginatedListData
object
3 properties
UpdateAccountRequest
object
Payload to update account
8 properties
CurrencyRateValue
object
2 properties
2 required
LicenseRateCard
object
11 properties
4 required
AccountPaginatedResponse
object
3 properties
PricingCycleInterval
string
Interval field allow you to define the billing interval you would like to set
PricingSchedulePaginatedResponse
object
3 properties
BillingEntitlementRateCard
object
Billing Entitlement rate card
8 properties
5 required
PurchaseListResponse
object
Represents a Purchase for List Response
15 properties
4 required
AccountAliasesPaginatedResponse
object
Paginated response for account aliases
2 properties
1 required
UpdatePricingScheduleRequestWithActions
Request to associate or disassociate a price plan to an account with actions
MaxQuantityBreachAction
string
Action to be taken when the license maxQuantity is breached: - DONOTHING: Refrain from granting any new licenses.
GrantDetails
object
Grant details of Credit Grant Rate Card
4 properties
2 required
CreatePricingRule
object
6 properties
4 required
UpdateProposalStatus
object
Approve or decline a proposal of a billing plan for an account
1 property
1 required
CreateAccountRequest
Payload to create account
AddAccountAliasesRequest
object
Payload to add aliases from account
2 properties
AccountAlias
object
Account Alias
6 properties
5 required
CurrencySlabRateDetail
object
The association of a currency along with its slab detail
4 properties
3 required
PricingModel
string
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 m…
CreateAccountAliasRequest
object
An alternative account identifier for event ingestion with a defined effective duration.
3 properties
1 required
PricingCycleConfig
object
Represents configurations related to pricing cycle
4 properties
2 required
BillingConfig
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Togai publishes across the network.
