Introduction
APIs
- Authentication
- Customers
- Accounts
- 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
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
Payload to create customer
billing address of the customer
City, district, suburb, town or village
Two letter country code ISO-3166-1 Alpha-2
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
Contact number
ZIP or postal code
State, county, province or region
Customer identifier
50
Name of the Customer
3 - 255
Primary email of the customer
320
Payload to create account
Identifier of the account
50
Name of the Account
3 - 255
Aliases which effective range
billing address of the customer
City, district, suburb, town or village
Two letter country code ISO-3166-1 Alpha-2
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
Contact number
ZIP or postal code
State, county, province or region
Aliases are tags that are associated with an account. Multiple aliases are allowed for a single 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.
3
Additional information associated with the account. Example: GSTN, VATN
Net term for the invoices of the account
Primary email of the account
320
Status of the created account defaults to ACTIVE
ACTIVE
, DRAFT
Tag for accounts are stored in lowercase
Response
Identifier of customer
50
Name of the Customer
3 - 255
Primary email of the customer
320
Unique identifier of customer
Structure of an account
Identifier of the customer
Identifier of the account
50
Name of the Account
3 - 255
Status of the account
ACTIVE
, DRAFT
, ARCHIVED
Unique identifier of the account
Unique identifier of the customer
billing address of the customer
City, district, suburb, town or village
Two letter country code ISO-3166-1 Alpha-2
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
Contact number
ZIP or postal code
State, county, province or region
list of aliases of the account
50
ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.
3
Invoice group details
billing address of the customer
City, district, suburb, town or village
Two letter country code ISO-3166-1 Alpha-2
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
Contact number
ZIP or postal code
State, county, province or region
320
Additional information associated with the account. Example: GSTN, VATN
Primary email of the customer
320
Tag for accounts are stored in lowercase
billing address of the customer
City, district, suburb, town or village
Two letter country code ISO-3166-1 Alpha-2
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
Contact number
ZIP or postal code
State, county, province or region