Skip to main content
POST
/
subscriptions
{
  "subscriptionId": "<string>",
  "status": "PENDING",
  "type": "<string>",
  "display": "<string>",
  "msisdn": "<string>",
  "customerId": "<string>",
  "customer": {
    "customerId": "<string>",
    "name": "<string>"
  },
  "productOfferingId": "<string>",
  "productOffering": {
    "productOfferingId": "<string>",
    "name": "<string>",
    "price": {
      "grossPrice": 10,
      "discount": 123,
      "netPrice": 5,
      "currency": "USD",
      "priceType": "ONE_TIME",
      "boundMonths": 12,
      "billingCycle": {
        "period": "MONTHLY",
        "interval": 1
      },
      "taxIncluded": true
    },
    "productOfferingGroupId": "<string>",
    "group": {
      "productOfferingGroupId": "<string>",
      "name": "<string>",
      "category": "SUBSCRIPTION_CELL"
    }
  },
  "subscriberId": "<string>",
  "subscriber": {
    "subscriberId": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "street1": "500 S Main St",
      "street2": "Apt 1",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "extensions": {},
  "sim": {
    "esim": true,
    "imei": "<string>",
    "iccid": "<string>"
  },
  "pendingMsisdn": {
    "msisdn": "<string>",
    "scheduledAt": "2023-12-25"
  },
  "pendingStatus": {
    "status": "PENDING",
    "scheduledAt": "2023-12-25"
  },
  "pendingProductOffering": {
    "scheduledAt": "2023-12-25",
    "productOfferingId": "<string>",
    "name": "<string>",
    "price": {
      "grossPrice": 10,
      "discount": 123,
      "netPrice": 5,
      "currency": "USD",
      "priceType": "ONE_TIME",
      "boundMonths": 12,
      "billingCycle": {
        "period": "MONTHLY",
        "interval": 1
      },
      "taxIncluded": true
    },
    "productOfferingGroupId": "<string>",
    "group": {
      "productOfferingGroupId": "<string>",
      "name": "<string>",
      "category": "SUBSCRIPTION_CELL"
    }
  },
  "porting": {
    "msisdn": "<string>",
    "status": "PENDING",
    "direction": "INBOUND",
    "scheduledAt": "2023-12-25"
  },
  "activatedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Body

application/json

The subscription to create.

Create a new subscription.

Note: this endpoint is disabled when Seamless OS manages billing, subscriptions can then be created by orders.

​
productOfferingId
string
required

The unique identifier for the product offering to subscribe to.

This controls what type of subscription is being created.

​
customerId
string
required

The unique identifier for the existing customer who will own this subscription.

​
subscriber
object
required

Subscriber details for this subscription.

​
sim
object
required

SIM card requirements and configuration.

​
msisdn
string

The phone number for this subscription.

  • Leave empty to have one assigned.
  • When the number pool is available, you can choose a number from the pool and provide the leaseToken.
  • When porting a number, provide the number and porting details.
Example:

"+15551234567"

​
leaseToken
string

Token received when leasing a number. Required when an msisdn is provided from the number pool.

​
porting
object

Details needed to port in a number for this subscription.

​
extensions
object

Additional subscription extensions fields for custom subscription types.

​
display
string

Custom display name for the subscription. If not provided, will be auto-generated from msisdn.

​
scheduleActivationAt
string<date>

Date when the subscription should be activated.

Example:

"2024-01-15"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Response

The created subscription.

A subscription represents a telecommunications service provisioned for a customer with embedded product and pricing details.

​
subscriptionId
string
required

The unique identifier for the subscription.

​
status
enum<string>
required

The status of the subscription.

Available options:
PENDING,
ACTIVATED,
BLOCKED,
CANCELLED,
PAUSED
​
type
string
required

The type of subscription, categorizing the service into various telecommunications service types.

​
msisdn
string
required

The currently active phone number for this subscription.

​
customer
object
required

Customer information embedded in responses. Sensitive details require separate API calls with appropriate authorization.

​
productOffering
object
required

Embedded representation of a product offering.

​
sim
object
required

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.

​
activatedAt
string<date-time>
required

The date and time when the subscription was activated.

​
createdAt
string<date-time>
required

The date and time when the subscription was created.

​
updatedAt
string<date-time>
required

The date and time when the subscription was last updated.

​
display
string

The display name for the subscription, typically a pretty-print of the msisdn.

​
customerId
string

The unique identifier for the customer.

​
productOfferingId
string

The unique identifier for the product offering.

​
subscriberId
string

The unique identifier for the subscriber.

​
subscriber
object

A subscriber is a user that has a subscription.

​
extensions
object

Additional subscription extensions fields provided for custom subscription types.

​
pendingMsisdn
object

Details about when a pending phone number change is scheduled for this subscription.

​
pendingStatus
object

Details about when a pending status change is scheduled for this subscription.

​
pendingProductOffering
object

Embedded representation of a product offering.

​
porting
object

Number porting information for subscriptions, indicating scheduled number transfers.

To get the detailed porting information, use the porting endpoint.

​
cancelledAt
string<date-time>

The date and time when the subscription was cancelled (if applicable).

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I