Skip to main content
POST
/
subscriptions
/
{subscriptionId}
/
in-porting
{
  "subscription": {
    "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": {}
  },
  "portingInfo": {
    "portingId": "<string>",
    "status": "pending",
    "estimatedCompletion": "2023-11-07T05:31:56Z",
    "nextSteps": [
      "<string>"
    ]
  }
}

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

Path Parameters

​
subscriptionId
string
required

The unique identifier of the subscription.

Body

application/json

Request to update porting details for a subscription.

​
details
object
required

description: Detailed information required for the porting process, varying by country and provider.

  • USPortingDetails
  • SwedishPortingDetails

Response

Porting details updated successfully.

​
subscription
object

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

​
portingInfo
object

Updated porting information and status.

⌘I