Postman collection

Open API spec

Togai documentation

API Reference

Change log

How-To's

Try for free

Demo app

Login

Get the status of a job

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

Activate a price plan

Add currencies to a price plan

Remove a draft currency from a price plan

Migrates accounts across price plans. This is an asynchronous process functioning on top of Togai's Jobs 
framework. Status of the created migrations can be obtained using the [Jobs APIs](https://docs.togai.com/api-reference/jobs/get-the-status-of-a-job)


Create a price plan migration

Archive 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

Returns a list of jobs with pagination and sort.

List jobs

Confirm a job

Reject a job

List individual job entries and current state of processing

List job entries

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 500 events.
Ingest large amounts of events up to 500 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 get the entitlements for a account

Get entitlements for a account

This API let’s you to validate the entitlement value for a account

Check entitlement value for a account

This API let’s you to get the entitlement value for a account

Get entitlement value for a account

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

Introduction

APIs

Get the status of a job

Authorizations

Path Parameters

Response