Getting started
API reference
- GETList subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTChange subscription SIM card
- GETGet eSIM QR code
- GETGet subscription in-porting
- POSTUpdate subscription porting details
- POSTPause subscription
- PUTChange subscription product offering
- GETGet change options for subscription
- POSTRestore subscription
- POSTSuspend subscription
- GET
A valid request URL is required to generate request examples{
"items": [
{
"subscriptionId": "<string>",
"status": "PENDING",
"type": "<string>",
"display": "<string>",
"msisdn": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
},
"sim": {
"esim": true,
"imei": "<string>",
"iccid": "<string>"
},
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subscriber": {
"subscriberId": "<string>",
"name": "<string>",
"email": "[email protected]",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"extensions": {},
"pendingMsisdn": {
"msisdn": "<string>",
"scheduledAt": "2023-12-25"
},
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"pendingProductOffering": {
"scheduledAt": "2023-12-25",
"product": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
},
"porting": {
"msisdn": "<string>",
"status": "PENDING",
"direction": "INBOUND",
"scheduledAt": "2023-12-25"
},
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}List subscriptions
List all subscription.
A valid request URL is required to generate request examples{
"items": [
{
"subscriptionId": "<string>",
"status": "PENDING",
"type": "<string>",
"display": "<string>",
"msisdn": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
},
"sim": {
"esim": true,
"imei": "<string>",
"iccid": "<string>"
},
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subscriber": {
"subscriberId": "<string>",
"name": "<string>",
"email": "[email protected]",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"extensions": {},
"pendingMsisdn": {
"msisdn": "<string>",
"scheduledAt": "2023-12-25"
},
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"pendingProductOffering": {
"scheduledAt": "2023-12-25",
"product": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
},
"porting": {
"msisdn": "<string>",
"status": "PENDING",
"direction": "INBOUND",
"scheduledAt": "2023-12-25"
},
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
The unique identifier of the customer to filter by.
The status of the subscription to filter by.
The status of the subscription.
PENDING, ACTIVATED, BLOCKED, CANCELLED, PAUSED The type of subscription, categorizing the service into various telecommunications service types.
The maximum number of items to return.
1 <= x <= 1000The number of items to skip before starting to collect the result set.
x >= 0Response
A list of subscriptions.
Show child attributes
Show child attributes
The unique identifier for the subscription.
The status of the subscription.
PENDING, ACTIVATED, BLOCKED, CANCELLED, PAUSED The type of subscription, categorizing the service into various telecommunications service types.
The display name for the subscription, typically a pretty-print of the msisdn.
The currently active phone number for this subscription.
Embedded representation of a product offering.
Show child attributes
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
Pricing information with discount details.
Show child attributes
Show child attributes
The currency code.
"USD"
The discount amount from the original price.
The final cost after all discounts are applied.
5
The type of pricing model applied to the product offering.
ONE_TIME, RECURRING The number of months the price is bound to (for recurring prices).
12
The unique identifier for the product offering group.
Product offering group information embedded in responses.
Show child attributes
Show child attributes
The unique identifier for the product offering group.
The name of the product offering group.
A product category is a sub-type for grouping offerings of the same type.
Typically, product offerings of the same type with the same category allow for switching between them. For upgrading and downgrading subscriptions and licenses, we recommend using their corresponding endpoints though.
"SUBSCRIPTION_CELL"
SIM card information for the subscription. Sensitive details like PUK require separate API calls.
Use dedicated SIM API endpoints with proper authorization to access sensitive information such as PUK.
Show child attributes
Show child attributes
Indicates whether the subscription uses eSIM technology.
International Mobile Equipment Identity, uniquely identifying the mobile device.
Only applicable for eSIM.
Integrated Circuit Card identifier, uniquely identifying the SIM card.
The date and time when the subscription was activated.
The date and time when the subscription was created.
The date and time when the subscription was last updated.
A subscriber is a user that has a subscription.
Show child attributes
Show child attributes
The unique identifier of the subscriber.
The name of the subscriber.
Optional email address of the subscriber.
The address of the subscriber.
In the US, this refers to the E911 address associated with the subscriber's phone number, which is used for emergency services.
Show child attributes
Show child attributes
The first line of the address, typically street and house number.
"500 S Main St"
The city or municipality of the address.
"Natick"
The zip code of the address.
Depending on the country, this may be referred to as a postal code or postcode.
Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').
"01701"
The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).
"US"
The second line of the address, typically apartment, suite, unit, building, floor, etc.
"Apt 1"
For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).
"CA"
A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).
An optional line for specifying a person, department, or attention to a specific entity within an address.
Date and time when the subscriber was created.
Date and time when the subscriber was last updated.
Details about when a pending phone number change is scheduled for this subscription.
Details about when a pending status change is scheduled for this subscription.
Pending product offering change.
Show child attributes
Show child attributes
The date when the pending product offering change is scheduled to occur.
Embedded representation of a product offering.
Show child attributes
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
Pricing information with discount details.
Show child attributes
Show child attributes
The currency code.
"USD"
The discount amount from the original price.
The final cost after all discounts are applied.
5
The type of pricing model applied to the product offering.
ONE_TIME, RECURRING The number of months the price is bound to (for recurring prices).
12
The unique identifier for the product offering group.
Product offering group information embedded in responses.
Show child attributes
Show child attributes
The unique identifier for the product offering group.
The name of the product offering group.
A product category is a sub-type for grouping offerings of the same type.
Typically, product offerings of the same type with the same category allow for switching between them. For upgrading and downgrading subscriptions and licenses, we recommend using their corresponding endpoints though.
"SUBSCRIPTION_CELL"
Number porting information for subscriptions, indicating scheduled number transfers.
To get the detailed porting information, use the porting endpoint.
Show child attributes
Show child attributes
The pending phone number that the subscription will be ported in with. This will always be a non-active number.
Current status of the porting process.
PENDING, IN_PROGRESS, SCHEDULED, COMPLETED, FAILED The direction of the number porting, either inbound (to us) or outbound (from us).
INBOUND, OUTBOUND The date when the number porting is scheduled to occur.
The date and time when the subscription was cancelled (if applicable).
Show child attributes
Show child attributes
The total number of items available.
The maximum number of items to return.
The number of items to skip before starting to collect the items.