The Accounts API provides organizations with a complete view of their active business accounts(individual accounts representing specific organizational units, departments), offering information to enhance compliance monitoring and centralized management.
Use cases:
Prerequisites:
Get a list of all accounts associated with the organization.
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
{- "_embedded": {
- "accounts": [
- {
- "id": "acc_045EAABBCCDD746VVV",
- "reference_code": "1234567",
- "name": "ABC, N.A. - LONDON BRANCH",
- "country": "US",
- "status": "active",
}
]
}
}
Returns information for a specific business account.
id | string Example: acc_01HTJA47C93ABKKR58T05JBAJB Unique identifier for the business account. |
{- "id": "acc_045EAABBCCDD746VVV",
- "reference_code": "1234567",
- "name": "ABC, N.A. - LONDON BRANCH",
- "country": "US",
- "status": "active",
}
The Messages API allows organizations to send SMS messages directly from authorized subscription numbers to one or more recipients.
Use cases:
Notes:
Prerequisites:
Sends SMS messages from authorized subscription numbers to specified recipients.
from | string^(\+\d{1,15}|\d{1,15})$ Authorized subscription number sending the message, in E.164 format |
to | Array of strings (Msisdn) <= 1000 items [ items^(\+\d{1,15}|\d{1,15})$ ] Array of up to 1,000 recipient phone numbers in E.164 format |
text | string <= 500 characters The content of the SMS message, limited to 500 characters. |
{- "from": "+11114567890",
- "to": [
- "+1234567890"
], - "text": "Thank you for using our service"
}
{- "sms_id": "sms_01JBCG33BC2PS4J76JN685GN56"
}
The Orders API enables organizations to streamline subscription management, including provisioning new services, suspending or resuming subscriptions, and swapping SIMs.
Use cases:
Prerequisites:
Submit a request to create a new subscription or make changes to the existing subscription associated with a specific account.
type required | string The order's requested action - create a new subscription. |
account_id required | string^acc_[0-9A-Z]{26}$ The account where the new subscription is provisioned. |
template_id | string^otpl_[0-9A-Z]{26}$ The ID of the pre-configured template which includes plans and phone numbers. |
required | object The individual utilizing the new subscription. |
required | object Configuration of the SIM profile to be provisioned. |
{- "type": "activate_subscription",
- "account_id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
- "template_id": "otpl_A00ABCDRT1F00AVRPTAQ5XQFUT",
- "subscriber": {
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "employee_id": "string",
- "group": "string"
}, - "sim_profile": {
- "sim_type": "esim",
- "delivery": {
- "type": "email",
- "to": [
- "user@example.com"
], - "cc": [
- "user@example.com"
]
}
}
}
{- "id": "order_01HZS5KETGM8XXF53WZJWDDV4C",
- "status": "pending",
- "type": "activate_subscription",
- "account_id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
- "subscription_id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
- "sim_profile": {
- "iccid": "8900000000000000000",
- "sim_type": "esim",
- "delivery": {
- "type": "email",
- "to": [
- "user@example.com"
], - "cc": [
- "user@example.com"
]
}, - "_links": {
}
}, - "phone_numbers": [
- {
- "msisdn": "string",
- "is_primary": true,
- "country": "string"
}
], - "subscriber": {
- "id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "employee_id": "string",
- "group": "string"
}, - "reason": "lost_or_stolen",
- "_links": {
}
}
Retrieve the status of a previously submitted order.
id | string^order_[0-9A-Z]{26}$ Example: order_01HZQ8GENA2K171RTJ3Z5FWW9R The uniquie identifier of the order. |
{- "id": "order_01HZS5KETGM8XXF53WZJWDDV4C",
- "status": "pending",
- "type": "activate_subscription",
- "account_id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
- "subscription_id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
- "sim_profile": {
- "iccid": "8900000000000000000",
- "sim_type": "esim",
- "delivery": {
- "type": "email",
- "to": [
- "user@example.com"
], - "cc": [
- "user@example.com"
]
}, - "_links": {
}
}, - "phone_numbers": [
- {
- "msisdn": "string",
- "is_primary": true,
- "country": "string"
}
], - "subscriber": {
- "id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "employee_id": "string",
- "group": "string"
}, - "reason": "lost_or_stolen",
- "_links": {
}
}
The Order Templates API enables organizations to retrieve their list of eSIM provisioning templates, including all associated products and service configurations.
Use cases:
Get a list of all order templates associated with the organization.
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
{- "_embedded": {
- "order-templates": [
- {
- "id": "otpl_01HZS5KETGM8XXF53WZJWDDV4C",
- "type": "activate_subscription",
- "description": "string",
- "products": [
- {
- "_embedded": {
- "product-offering": {
- "id": "prodoff_01HZS5KETGM8XXF53WZJWDDV4C",
- "type": "plan",
- "name": "10GB Plan"
}
}
}
], - "_links": {
- "self": {
},
}
}
]
}
}
Returns information for a specific order template.
id | string Example: otlp_01HTJA47C93ABKKR58T05JBAJB Unique identifier for the order template. |
{- "id": "otpl_01HZS5KETGM8XXF53WZJWDDV4C",
- "type": "activate_subscription",
- "description": "string",
- "products": [
- {
- "_embedded": {
- "product-offering": {
- "id": "prodoff_01HZS5KETGM8XXF53WZJWDDV4C",
- "type": "plan",
- "name": "10GB Plan"
}
}
}
], - "_links": {
- "self": {
},
}
}
The Products API provides organizations with comprehensive visibility into all products associated with their accounts and subscriptions, including base plans and add-ons.
Use cases:
Prerequisites:
Get a list of all products associated with the organization.
account_id | string Example: account_id=acc_01HTQ8VBN4DEJP5S8BPV4657VG The account ID that the product belongs to. |
status | string Enum: "active" "terminated" The status of the product |
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
{- "_embedded": {
- "products": [
- {
- "id": "prod_045EAABBCCDD746VVV",
- "status": "active",
- "activated_at": "2019-08-24T14:15:22Z",
- "terminates_at": "2019-08-24T14:15:22Z",
- "_links": {
- "subscription": {
}
}
}
]
}
}
Returns information for a specific product.
id | string Example: prod_01HTJA47C93ABKKR58T05JBAJB Unique identifier for the product. |
{- "id": "prod_045EAABBCCDD746VVV",
- "status": "active",
- "activated_at": "2019-08-24T14:15:22Z",
- "terminates_at": "2019-08-24T14:15:22Z",
- "_links": {
- "subscription": {
}
}
}
The Subscriber API allows organizations to retrieve a detailed list of their subscribers (individual users associated with the organization’s accounts e.g. employees).
Use cases:
Pre-requisites:
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
{- "_embedded": {
- "subscribers": [
- {
- "id": "sbr_0123AAABBBBCCC123XY456",
- "first_name": "John",
- "last_name": "Doe",
- "email": "john.doe@example.com",
- "employee_id": "ED123",
- "group": "E1",
- "_links": {
}
}
]
}
}
id | string Example: sbr_01HTQ8Z5HR26EN2HE797W5SZP9 A unique identifier for the subscriber, formatted as a 26-character alphanumeric string prefixed with "sbr_" |
{- "id": "sbr_0123AAABBBBCCC123XY456",
- "first_name": "John",
- "last_name": "Doe",
- "email": "john.doe@example.com",
- "employee_id": "ED123",
- "group": "E1",
- "_links": {
}
}
status | string Enum: "active" "terminated" The status of the subscription |
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
Prefer | string Example: transclude="subscriber;account;sim_profile;phone_numbers;services" What embedded resources to include in the response |
{- "_embedded": {
- "subscriptions": [
- {
- "id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
- "status": "active",
- "created_at": "2023-01-01T00:00:00:000Z",
- "terminated_at": null,
- "_embedded": {
- "account": {
- "id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
- "reference_code": "123456789",
- "name": "ABC, N.A. - LONDON BRANCH",
- "country": "US"
}, - "subscriber": {
- "id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "employee_id": "string",
- "group": "string"
}, - "sim_profile": {
- "iccid": "string",
- "sim_type": "esim",
- "_links": {
}
}, - "phone_numbers": {
- "_links": {
}, - "_embedded": {
- "phone_numbers": [
- {
- "msisdn": "string",
- "is_primary": true,
- "country": "string"
}
]
}
}, - "services": {
- "_links": {
}, - "_embedded": {
- "services": [
- {
- "type": "voice",
- "enabled": true
}
]
}
}
}, - "_links": {
- "self": {
}, - "subscriber": {
}, - "sim_profile": {
}, - "phone_numbers": {
}, - "services": {
}
}
}
]
}
}
id | string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription |
Prefer | string Example: transclude="subscriber;account;sim_profile;phone_numbers;services" What embedded resources to include in the response |
{- "id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
- "status": "active",
- "created_at": "2023-01-01T00:00:00:000Z",
- "terminated_at": null,
- "_embedded": {
- "account": {
- "id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
- "reference_code": "123456789",
- "name": "ABC, N.A. - LONDON BRANCH",
- "country": "US"
}, - "subscriber": {
- "id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "employee_id": "string",
- "group": "string"
}, - "sim_profile": {
- "iccid": "string",
- "sim_type": "esim",
- "_links": {
}
}, - "phone_numbers": {
- "_links": {
}, - "_embedded": {
- "phone_numbers": [
- {
- "msisdn": "string",
- "is_primary": true,
- "country": "string"
}
]
}
}, - "services": {
- "_links": {
}, - "_embedded": {
- "services": [
- {
- "type": "voice",
- "enabled": true
}
]
}
}
}, - "_links": {
- "self": {
}, - "subscriber": {
}, - "sim_profile": {
}, - "phone_numbers": {
}, - "services": {
}
}
}
id | string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription |
{- "_links": {
}, - "_embedded": {
- "phone_numbers": [
- {
- "msisdn": "string",
- "is_primary": true,
- "country": "string"
}
]
}
}
The Usage API retrieves near real-time summary of subscriptions usage items for all the business units within an organizations. It includes detailed event types such as voice, SMS, and data usage. The response items are arranged in descending order by date with the most recently usage appearing first.
Use cases:
Prerequisites:
List itemized usage events
from-date | string <date> (Iso8601Date) ^([0-9]{4})-(?:[0-9]{2})-([0-9]{2})$ The start date of the usage event. |
to-date | string <date> (Iso8601Date) ^([0-9]{4})-(?:[0-9]{2})-([0-9]{2})$ The end date of the usage event. |
account-id | string (AccountID) ^acc_[0-9A-Z]{26}$ Example: account-id=acc_01HTQ8VBN4DEJP5S8BPV4657VG Unique identifier for the account associated with the usage data. |
subscription-id | string (SubscriptionID) ^sub_[0-9A-Z]{26}$ Example: subscription-id=sub_01HTJA47C93ABKKR58T05JBAJB Unique identifier for the subscription linked to the usage data. |
subscriber-id | string (SubscriberID) ^sbr_[0-9A-Z]{26}$ Example: subscriber-id=sbr_01CWCM8KDGFTCYVH3KDP46HDXV Unique identifier for the subscriber linked to the usage data. |
msisdn | string (UsageMsisdn) ^\d{12,15}$ Example: msisdn=44000000000001 Mobile number related to the usage event (E.164 format). |
type | Array of strings (Type) Items Enum: "voice" "data" "sms" The type of usage item. |
direction | string (Direction) Enum: "inbound" "outbound" The direction of the usage. |
cost-type | Array of strings (CostType) Items Enum: "free" "in_bundle" "out_of_bundle" Costs associated with the usage event. |
limit | integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response. |
cursor | string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list. |
{- "_embedded": {
- "items": [
- {
- "id": "uitem_01JBH38XBWTJYJAZHSC2STR2J9",
- "type": "voice",
- "direction": "inbound",
- "technology": "cs",
- "from_msisdn": 44000000000001,
- "to_msisdn": 44000000000002,
- "location_country": "GB",
- "roaming": false,
- "is_recorded": true,
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "processed_at": "2019-08-24T14:15:22Z",
- "quantity": 45,
- "unit": "seconds",
- "charged_quantity": 60,
- "cost_type": "free",
- "_links": {
- "subscription": {
}, - "subscriber": {
}
}
}
]
}
}