Skip to main content
POST
/
subscriptions
/
{subscriptionId}
/
in-porting
Update subscription porting details
curl --request POST \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/in-porting \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "details": {
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "accountNumber": "<string>",
    "passcode": "<string>"
  }
}
'
{
  "subscription": {
    "subscriptionId": "<string>",
    "status": "PENDING",
    "type": "<string>",
    "display": "<string>",
    "msisdn": "<string>",
    "customer": {
      "customerId": "<string>",
      "name": "<string>"
    },
    "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",
    "referenceId": "crm-subscription-12345",
    "productOffering": {
      "productOfferingId": "<string>",
      "name": "<string>",
      "price": {
        "currency": "USD",
        "priceType": "ONE_TIME",
        "discount": 5,
        "netPrice": 5,
        "boundMonths": 12,
        "billingCycle": {
          "period": "MONTHLY",
          "interval": 1
        },
        "currencyOptions": {}
      },
      "group": {
        "productOfferingGroupId": "mobile-plans",
        "name": "Mobile Plans",
        "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
        "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
        "internalDescription": "Core mobile offerings targeting consumer and business segments"
      }
    },
    "subscriber": {
      "subscriberId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "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",
          "priceType": "ONE_TIME",
          "discount": 5,
          "netPrice": 5,
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          },
          "currencyOptions": {}
        },
        "group": {
          "productOfferingGroupId": "mobile-plans",
          "name": "Mobile Plans",
          "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
          "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
          "internalDescription": "Core mobile offerings targeting consumer and business segments"
        }
      }
    },
    "porting": {
      "msisdn": "<string>",
      "status": "PENDING",
      "direction": "INBOUND",
      "scheduledAt": "2023-12-25"
    },
    "cancelledAt": "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 string length: 256

Path Parameters

​
subscriptionId
string
required

The identifier of the subscription. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-subscription-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Body

application/json

Request to update porting details for a subscription.

​
details
USPortingDetails · object
required

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

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.