How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Togai Price Plans API

Price Plan level calls

Togai Price Plans 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 Price Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.

This API exposes 9 operations across 6 paths, and defines 53 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/.

9 operations 6 paths 53 schemas 2 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.togai.com
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Togai Price Plans API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (Bearer ) (bearerAuth). An API key is passed in the header as X-API-Key (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Price Plans 9

Price Plan level calls

POST
/price_plans
Create a Price Plan
createPricePlan 1 param body → 200400401403404429default
GET
/price_plans
List Price Plans
getPricePlans 2 params → 200400401403404429default
PATCH
/price_plans/{price_plan_id}
Update a Price Plan
updatePricePlan 1 param body → 200400401403404429default
GET
/price_plans/{price_plan_id}
Get a Price Plan
getPricePlan 2 params → 200400401403404429default
DELETE
/price_plans/{price_plan_id}
Archive a Price Plan
archivePricePlan 1 param → 200400401403404429default
POST
/price_plans/{price_plan_id}/activate
Activate a Price Plan
activatePricePlan 1 param body → 200400401403404429default
POST
/price_plans/{price_plan_id}/currencies
Add Currencies to a Price Plan
addCurrencyToPricePlan 1 param body → 200400401403404429default
DELETE
/price_plans/{price_plan_id}/currencies/{currency_id}
Remove a Draft Currency From a Price Plan
removeCurrencyFromPricePlan 2 params → 200400401403404429default
POST
/price_plans/migration
Create a Price Plan Migration
pricePlanMigration body → 201400401403404429default

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are PricePlanDetails (12 properties), LicenseRateCard (11 properties), PricePlanListData (11 properties), CreatePricePlanDetails (10 properties). Each schema is shown below with its type and property counts.

CreditRateDetails
object
Amount to be credited
2 properties 2 required
EntitlementOverageRateCard
object
7 properties 3 required
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
UpdatePricePlanRequest
object
Request to update a price plan
5 properties
PricePlan
object
Price plan entity
6 properties 5 required
AddCurrencyToPricePlanRequest
object
Request to adding currency to a price plan
8 properties 1 required
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
ExpiryType
string
Expiry type of grant
CreatePricePlanDetailsOverride
object
9 properties
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
PriceType
string
ProratedRefundMode
string
CreatePricePlanMigrationRequest
Request to create price plan migration request
PricePlanType
string
Type of price plan
PricePlanPaginatedResponse
object
3 properties 1 required
pricePlanMigrationConfig
object
Migrate all account associations of a price plan to another price plan
6 properties 3 required
CreditGrantRateCard
object
Credit grant rate card
8 properties 3 required
RateValue
object
Represents a rate
3 properties 2 required
CreatePricePlanRequest
object
Request to create a price plan
5 properties 2 required
FixedFeeRateCard
object
8 properties 3 required
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…
FeatureConfig
object
Feature configuration object
3 properties 2 required
BaseSuccessResponse
object
1 property 1 required
PricingSchedule
object
Represents effectiveness period and config of a price plan. i.e, price plan bound by time.
7 properties 5 required
FixedFeeType
string
Fixed fee applies either for a one-time occurrence or for each cycle.
CreatePricePlanDetails
object
10 properties 1 required
RecurrenceConfig
object
2 properties
PricingRuleAction
object
5 properties 1 required
ActivatePricePlanRequest
object
Request to activate currencies of a price plan
1 property 1 required
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…
CurrencyRateValue
object
2 properties 2 required
LicenseRateCard
object
11 properties 4 required
PricingCycleInterval
string
Interval field allow you to define the billing interval you would like to set
BillingEntitlementRateCard
object
Billing Entitlement rate card
8 properties 5 required
PricePlanListData
object
Data of price plan list
11 properties 9 required
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
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…
PricingCycleConfig
object
Represents configurations related to pricing cycle
4 properties 2 required
BillingConfig
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

togai-price-plans-api-openapi.yml Raw ↑

Other APIs Togai publishes across the network.

Togai Accounts API
Togai AddOns API
Togai Aliases API
Togai Authentication API
Togai Credits API
Togai Customer Portal API
Togai Customers API
Togai Entitlements API
Togai Event Ingestion API
Togai Event Management API
Togai Event Schemas API
Togai Feature API
Where this information came from

This is an independent, third-party profile of Togai Price Plans API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.