Skip to main content
GET
/
subscriptions
/
{subscriptionId}
Get subscription
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId} \
  --header 'X-Api-Key: <api-key>'
{
  "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": {}
}

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.

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.

Response

A subscription object.

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.

​
display
string
required

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

​
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.

​
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.

​
referenceId
string

A reference identifier provided by API clients to identify this subscription in their own systems. Must be unique per tenant. Use this field to look up subscriptions by your external identifier or to create/retrieve subscriptions during order creation.

Maximum string length: 255
Example:

"crm-subscription-12345"

​
productOffering
object

Embedded representation of a product offering.

​
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

Pending product offering change.

​
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.