Postman collection

Open API spec

Togai documentation

API Reference

Change log

How-To's

Try for free

Demo app

Login

This API let’s you to initiate a purchase for an account

Initiate a purchase

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


Represents the number of pricing cycles after which the rate card will be billed

Represents the offset for pricing cycles after which the rate card will be billed

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.

Credit grant applies either for a one-time occurrence or for each cycle.

The association of a currency along with its slab detail

The amount of credit that needs to be credited

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

Unique Identifier of the attached Feature

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

FixedFeeRateCard

Fixed fee applies either for a one-time occurrence or for each cycle.

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


LicenseRateCard

Max allowed quantity for a particular license in a price plan

LicenseRateCardConfig

Action to be taken when the license maxQuantity is breached: 
- `DO_NOTHING`: Refrain from granting any new licenses.


MinimumCommitment

Represents configurations related to pricing cycle

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}


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.


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


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.


Interval field allow you to define the billing interval you would like to set

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](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)


entitlements override options for purchase of a price plan for an account

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

Rate cards can have single or multiple slab up to 100.

Represents the number of pricing cycles after which the rate card will be charged

Represents the offset for pricing cycles after which the rate card will be charged

Represents a pricing priceType (rates + slabs) for usage price plan

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


Name your rate card, this will be displayed in the Togai App

Information related to wallet topup purchase

Specifies the amount to be paid to top up wallet with the specified top up amount. 
If left null, purchase amount will be same as top up amount


Specifies the value to be topped up in the wallet

bearerAuth

Introduction

How Togai works?

Event Schemas

Event enrichments

Event Ingestion

Usage Meter

Billable Items

Overview

Pricing cycle

Rate cards

Pricing Rules

Lifecycle and version control

Customers

Price plan overrides

Price Plan Schedule

Quote to cash overview

Proposals

Purchases

Invoices overview

Invoice groups

Invoice templates

Credits

Payments and wallet

Insights overview

Reports

Revenue simulator

Alerts

Admin Center

Settings

Quotas and Limits

JSON Logic at Togai

Togai integrates with a variety of third party (3P) platforms for different use cases and requirements.

Supported Integrations

Webhooks

Stripe

Adyen

Paystack

Razorpay

Verifone

AWS S3

AWS Redshift

Snowflake

JDBC

Postgres

Prometheus

Victoria Metrics

AWS Marketplace

Zuora

Chargebee

MS Dynamics 365

Netsuite

Quickbooks

Sage

Xero

Odoo

ZohoBooks

Payday

Salesforce

Hubspot

DocuSign

AWS Simple Email Service

Slack

SMTP

MS Exchange Online

First Promoter

Getting Started

Authentication 🔐

Pagination 📄

Generates and returns a bearer token. Behavior of this API differs on the basis of the auth mechanism used to make the request.
  - For API key auth, this API generates a JWT token whcih is valid for 24 hours and returns it.
  - For JWT bearer auth, returns the same JWT token in response
For information on how to generate API token, refer [Generating New API Keys](https://docs.togai.com/api-reference/authentication#generating-new-api-keys) section of docs.


Generate short lived bearer token

Generates and returns a bearer token belonging to a contact scoped to the accounts to which portal access has been granted

Generate portal token

Get delegate token for customer portal

Returns a list of customers with pagination and sort.

List customers

This API let’s you to create customers and corresponding accounts.

Create a customer

Get customer information using customer_id.

Get a customer

This API let’s you to delete a customer using customer_id.

Delete a customer

This API let’s you to update a customer’s information using customer_id.

Update a customer

Returns a list of accounts of a customer with pagination and sort.

List accounts of customer

This API let’s you to create an account for a customer using customer_id.

Create an account

Get account information using customer_id and account_id.

Get an account

This API let’s you to delete a customer using customer_id and account_id.

Delete an account

This API let’s you to update an account’s information using customer_id and account_id.

Update an account

Returns a list of aliases with pagination and sort.

List all aliases

Create an alias

Get an alias

This API let’s you to delete an alias using alias.

Delete an alias

Returns a list of event schema with pagination.

List event schemas

Create an event schema with attributes and dimensions to process events.

Create an event schema

Get an event schema

To delete(archive) an event schema, you’re required to archive associated active usage meters if any.

Delete an event schema

Update an event schema and add new attributes and dimensions

Once an event schema is activated, you cannot update or delete existing attributes and dimensions however you can add new attributes and dimensions and update event schema description.
    operationId: updateEventSchema


Update an event schema

Get a list of all the versions of an event schema

List all event schema versions

Activate an event schema

You can deactivate an event schema using this API. In case you have an activate usage meter associated with the event schema, you will need to deactivate it first and then try deactivating the event schema.


Deactivate an event schema

Get a list of usage meters associated with an event schema

List usage meters for event schema

Create an usage meter and associate with an event schema

Create an usage meter

Get an usage meter using event schema name and usage meter id.

Get usage meter

Delete an Usage Meter

This API lets you update an existing usage meter.

Update an usage meter

Activate usage meter

Make an existing active usage meter to be inactive
Active Usage Meters with active Pricing Plan attached can also be deactivated.


Deactivate usage meter

List addOns

Create an AddOn

Get an addon

Delete an addon

Update an addon

This API let’s you to fetch a list of licenses updates with multiple query parameters

Get a list of licenses updates

This API let’s you to add a license entry

Update a license entry

This API let’s you to fetch a list of named licenses updates with multiple query parameters

Get a list of named licenses updates

Get a list of features along with its associations

List Feature

Create a Feature optionally associate with one or more event_schemas

Create a Feature and optionally associate with one or more event_schemas

Get a Feature

Update an existing feature and its eventSchema associations


Update a Feature

List price plans

This API let's you create and price plan
Learn more about [Price Plans](https://docs.togai.com/docs/priceplan)


Create a price plan

Get a price plan details using price plan id

Get a price plan

Update an existing price plan
Price Plans with status as DRAFT alone can be updated . Learn more about [Price plans](https://docs.togai.com/docs/priceplan) from our Guides


Update a price plan

Activate a price plan details using price plan id

Introduction

APIs

Initiate a purchase

Authorizations

Path Parameters

Body

Response