- Postman collection
- Open API spec
- Authentication
- Customers
- Accounts
- Aliases
- Event Schemas
- Usage Meters
- AddOns
- Licenses
- Feature
- Price Plans
- Settings
- Price Experimentation
- Jobs
- Event Ingestion
- Entitlements
- Event Management
- Metrics
- Credits
- Invoices
- Payments
- Wallet
- InvoiceGroups
APIs
Create a customer
This API let’s you to create customers and corresponding accounts.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Customer identifier
Name of the Customer
Primary email of the customer
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
STRING, NUMERIC, JSON, JSON_LOGIC Payload to create account
Identifier of the account
Name of the Account
Use ISO 4217 currency code in which the account must be invoiced.
For example: AED is the currency code for United Arab Emirates dirham.
Aliases are tags that are associated with an account. Multiple aliases are allowed for a single account.
Aliases which effective range
Effective from date, if not provided, it will be set to -infinity
Effective until date, if not provided, it will be set to +infinity
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 account
STRING, NUMERIC, JSON, JSON_LOGIC Net term for the invoices of the account
Additional information associated with the account. Example: GSTN, VATN
Tag for accounts are stored in lowercase
Status of the created account defaults to ACTIVE
ACTIVE, DRAFT Response
Identifier of customer
Unique identifier of customer
Name of the Customer
Primary email of the customer
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
STRING, NUMERIC, JSON, JSON_LOGIC Structure of an account
Identifier of the account
Unique identifier of the account
Unique identifier of the customer
Name of the Account
Identifier of the customer
ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.
list of aliases of the account
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
Status of the account
ACTIVE, DRAFT, ARCHIVED STRING, NUMERIC, JSON, JSON_LOGIC Invoice group details
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
Additional information associated with the account. Example: GSTN, VATN
Tag for accounts are stored in lowercase