Accounts
List accounts of customer
Introduction
APIs
- Authentication
- Customers
- Accounts
- GETList accounts of customer
- POSTCreate an account
- GETGet an account
- DELDelete an account
- PATCHUpdate an account
- Account Aliases
- (Deprecated) Plan Associations
- (Deprecated) Purchases
- (Deprecated) Proposals
- Schedules
- GET
- Aliases
- Event Schemas
- Usage Meters
- AddOns
- Licenses
- Feature
- (Deprecated) Price Plans
- Price Plan V2
- Settings
- Price Experimentation
- Jobs
- Event Ingestion
- Entitlements
- Event Management
- Metrics
- Credits
- Invoices
- Payments
- Wallet
- InvoiceGroups
- Alerts
- Reports
Accounts
List accounts of customer
Returns a list of accounts of a customer with pagination and sort.
GET
/
accounts
curl --request GET \
--url https://api.togai.com/accounts \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "G234DZZKBKACATFFGVGEMERFI",
"togaiAccountId": "account.dsvvre314.dcs314",
"customerId": "ACME_CUSTOMER_1",
"togaiCustomerId": "customer.dsvvre314.dcs314",
"name": "ACME Enterprise - Account2",
"status": "ACTIVE",
"aliases": [
{
"alias": "account2@acme.com"
},
{
"alias": "+1234567890"
}
]
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
"context": {
"pageSize": 10
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Example:
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
Example:
10
Response
200
application/json
Response for list customers request
Structure of an account
Identifier of the account
Maximum length:
50Unique identifier of the account
Unique identifier of the customer
Name of the Account
Required string length:
3 - 255Identifier of the customer
Status of the account
Available options:
ACTIVE, DRAFT, ARCHIVED Example:
"ACTIVE"
ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.
Required string length:
3Example:
"USD"
billing address of the customer
Contact number
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
ZIP or postal code
City, district, suburb, town or village
State, county, province or region
Two letter country code ISO-3166-1 Alpha-2
Primary email of the customer
Maximum length:
320Example:
"admin@example.com"
Invoice group details
Maximum length:
320billing address of the customer
Contact number
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
ZIP or postal code
City, district, suburb, town or village
State, county, province or region
Two letter country code ISO-3166-1 Alpha-2
Additional information associated with the account. Example: GSTN, VATN
Tag for accounts are stored in lowercase
curl --request GET \
--url https://api.togai.com/accounts \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "G234DZZKBKACATFFGVGEMERFI",
"togaiAccountId": "account.dsvvre314.dcs314",
"customerId": "ACME_CUSTOMER_1",
"togaiCustomerId": "customer.dsvvre314.dcs314",
"name": "ACME Enterprise - Account2",
"status": "ACTIVE",
"aliases": [
{
"alias": "account2@acme.com"
},
{
"alias": "+1234567890"
}
]
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
"context": {
"pageSize": 10
}
}