Postman collection

Vault

Blog

Togai documentation

API Reference

Change log

SignUp

Demo

Login

Getting Started

Togai

Introduction to Togai

Team behind Togai

Event Ingestion

Event Schemas

Enriched Values

Billable Items Overview

Usage Meter

Add-Ons

Price Plans

Price plan overrides

Customers

Credits

Price Plan Schedule

Proposals

Invoices

Entitlements

Admin Center

Quotas and Limits

Concepts

Stripe

Chargebee

ZohoBooks

Zuora

Razorpay

First Promoter

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

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

Add aliases to an account using customer_id and account_id.

Add Aliases to account

Remove existing aliases tagged to an account using this API

Remove Aliases to account

This API let’s you to detach or attach a price plan with an existing account

Dissociate or associate a price plan with an account

Get Purchase information for an account using account_id and price_plan_id

Get all purchases for an account

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

Initiate a purchase

Get purchase information of an account for a specific plan using account_id and price_plan_id

Get a specific purchase of an account

List all proposals of an account

This API let’s you to create a proposal of a billing/entitlement plan for an account

Propose a purchase of a plan

Get proposal information

This API let’s you to detach/attach one or more price plans from/to an existing account

Edit schedules of an account.

Returns a list of pricing schedules of an account with pagination and sort.

List pricing schedules of an account

This API let’s you to approve or decline a proposal of a billing plan for an account

Approve or decline a purchase of a billing plan

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

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

Activate a price plan

Add currencies to a price plan

Remove a draft currency from a price plan

Lists settings

Create a setting

Get a setting

Update a setting

Calculate and return the revenue for a existing or new price plan

Get the status of a migration

Migrates accounts which are associated to one price plan to another price plan

Returns a list of migrations with pagination and sort.

List migrations

This API let’s you to ingest events to your Togai account.
Events ingested using this API will be processed via associated usage meters and further via associated price plans to generate final billable value to invoice the customer
Read more about [Event Ingestion](https://docs.togai.com/docs/event-ingestion)


Ingest events to Togai

This API let’s you to ingest events in batch upto 1000 events.
Ingest large amounts of events up to 1000 in batches in an array using this API.

Ingest events to Togai in batch

This API let’s you to ingest an event if a user is entitled to a feature

Ingest event if a user is entitled to a feature

This API let’s you to get the feature credits balance

Get Feature credits balance

This API let’s you to list the feature credits entries of a feature for an account

List feature credits entries of a feature for an account

#### This API let's you to update the following attributes: `effectiveUntil` and `granted`

- **effectiveUntil**: must be in future
- **granted**: must be greater than the existing usage (previous granted - current balance)


Update a feature credits entry

This API let’s you to void the feature credits entries of a feature for an account

Void a feature credits entry of a feature for an account

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

Get a list of usage events with multiple query options

Fetch details of a particular event using the event ID.

Get an usage event using event id

#### This API lets you to revert the changes caused by events.

- **Usages**: Reduction of all usages associated with this event
- **Revenue**: Reduction of all revenues associated with this event
- **Entitlements**: Entitlements(Feature Credits) consumed by this event are granted back to the account.


Undo ingested events.

Togai Metrics API allows you to fetch different metrics from Events, Usage Meters and PricePlans with multiple queryable options.
A single request can query up to five metrics. 
Single response can contain a maximum of 100 data points.


Get Togai Metrics

List credits

Grant credit

Get credit details

Void credit

Credit balance for Account

List invoices

Get an invoice

Add or update miscellaneous charges in Invoice

Update payment status in Invoice

Add or update miscellaneous charges in upcoming Invoice for a account

This API let’s you to list invoice groups

List Invoice Groups

This API let’s you to create an invoice group

Create an invoice group

This API let’s you to get information of an invoice group

Get information of an invoice group

This API let’s you to add accounts to an invoice group

Add accounts to an invoice group

This API let’s you to remove accounts from an invoice group. Removing all accounts will also delete the invoice group

Introduction

APIs

Getting Started

Togai Environments 📒

Postman collection

Introduction

APIs

​Togai Environments 📒

​Postman collection

Togai Environments 📒

Postman collection