Skip to main content

Get connectivity subscription​

Fetches a connectivity subscription with optionally included resources. A connectivity subscription always belongs to a profile and to an IoT subscription. If the connectivity subscription belongs to a virtual profile, then it will also belong to an eUICC which holds the virtual profile.

Path Parameters
  • imsi string required

    Possible values: Value must match regular expression ^[0-9]{6,15}$

    IMSI to perform request on.

Query Parameters
  • include string[]

    Possible values: [servicePolicy, iotSubscription, euicc, profile]

    Related resources to include in response. Format as a comma separated list. Omitting this query parameter means that no related resources will be included in response. Note that including resources may result in longer response times so only include what you actually need.

  • extendWith string[]

    Possible values: [*, fixedIpAddresses, imei]

    Extends the attributes property in the response body with the specified properties. Format as a comma separated list. Set the value to * to extend with all available properties. Omitting this query parameter means that no optional properties will be present in attributes. Note that including extended properties may result in longer response times.

Responses

Contains the requested connectivity subscription.

Schema
  • attributes object

    Attributes present in the response depends on profile type.

    anyOf
  • imsi string

    Possible values: Value must match regular expression ^[0-9]{6,15}$

    International Mobile Subscriber Identity. Uniquely identifies a subscriber in the mobile network.

  • iccid string

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Integrated Circuit Card ID. Uniquely identifies a UICC (SIM card) or an eUICC profile.

  • msisdn string

    Possible values: Value must match regular expression ^[0-9]{5,15}$

    Mobile Station International Subscriber Directory Number. This is equivalent to the phone number, including the country code.

  • mode string

    Possible values: [ACTIVE, ACTIVE_NO_BILLING, DEACTIVATED, PAUSED, TERMINATED]

    The mode of the subscription. This determines whether the subscription can connect to the network and how the subscription is billed.

  • firstActivationDate date-time

    Time when profile entered ACTIVE mode for the first time.

  • trmExitedAt date-time

    Time when profile exited Test Ready Mode (TRM). Is null if no TRM exit has been registered.

  • fixedIpAddresses object[]

    Fixed IP addresses associated with this subscription.

  • ipAddress string

    Possible values: Value must match regular expression ^[a-fA-F0-9.\/:]{1,100}$

  • subnet string

    Possible values: Value must match regular expression ^[a-fA-F0-9.\/:]{1,100}$

  • ipVersion string

    Possible values: [IPv4, IPv6]

  • apnName string

    Possible values: Value must match regular expression ^[a-zA-Z0-9.]{3,256}$

  • radiusServer string
  • imei object

    IMEI related information.

  • assignedImei string

    Possible values: Value must match regular expression ^[0-9]{14,16}$

    Assigned IMEI for the subscription. Null if no assigned IMEI.

  • detectedImei string

    Possible values: Value must match regular expression ^[0-9]{14,16}$

    Detected IMEI for the subscription. Null if no detected IMEI.

  • relationships object
  • iotSubscription object

    References an IoT subscription that is related to this resource. The url property can be used to GET the resource. The attributes property will be null unless the query parameter include specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

  • url string

    Possible values: non-empty and <= 256 characters

  • attributes object
  • id string

    Possible values: Value must match regular expression ^[85,97]{2}[23456789ABCDEFGHJKLMNPQRSTUVWXYZ]{16}$

    Identifies the IoT subscription.

  • subscriptionType string

    Possible values: [IOT_CONNECT]

    The subscription type.

  • domain object

    The domain that owns this subscription.

  • domainId string

    Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

    Domain the resource belongs to. Used to determine which users have access to the resource.

  • metadata object

    All metadata key-value pairs associated with this subscription. This object contains dynamic properties since metadata has a customized definition process.

  • property name* string
  • lastModifiedAt date-time

    Specifies when the IoT subscription or any of its parts was last updated.

  • euicc object

    References an eUICC that is related to this resource. The url property can be used to GET the resource. The attributes property will be null unless the query parameter include specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

  • url string

    Possible values: non-empty and <= 256 characters

  • attributes object
  • eid string

    Possible values: Value must match regular expression ^[0-9]{32}$

    Uniquely identifies an eUICC (eSIM).

  • enabledProfile string

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    ICCID of the currently enabled profile.

  • bootstrapProfile string

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    ICCID of the bootstrap profile, i.e. the profile that was first enabled on this eUICC.

  • profile object

    References a profile that is related to this resource. The url property can be used to GET the resource. The attributes property will be null unless the query parameter include specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

  • url string

    Possible values: non-empty and <= 256 characters

  • attributes object
  • iccid string

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Integrated Circuit Card ID. Uniquely identifies a UICC (SIM card) or an eUICC profile.

  • profileType string

    Possible values: [SIM_PROFILE, VIRTUAL_PROFILE]

    Specifies the type of profile. SIM_PROFILE means the profile resides on a UICC. VIRTUAL_PROFILE means the profile resides on an eUICC.

  • isEnabled boolean

    True if this is the currently enabled profile on an eUICC or if this is on a UICC. False if this is a disabled profile on an eUICC.

  • cmp string

    Possible values: [IOTA_EU, ARQIA_BR, THINGSPACE_US]

    The profile's Connectivity Management Platform (CMP) determines which underlying connectivity platform the profile belongs to and determines what kind of data is available for the profile and its connectivity subscription.

  • connectivityProfile object
  • id string

    Possible values: [GLOBAL_SUBSCRIPTION, LOCAL_SUBSCRIPTION, BR_DATORA, BR_DATORA_MULTI]

    The connectivity profile determines capabilities of a profile and its connectivity subscription.

  • name string

    Human readable name of the connectivity profile.

  • pinPuk object

    PIN and PUK information. Only available if specified using the extendWith query parameter. This property is only available for profiles on the IOTA_EU connectivity management platform.

  • pin1 string

    Possible values: Value must match regular expression ^[0-9]{4,8}$

    Identifies the PIN code.

  • pin2 string

    Possible values: Value must match regular expression ^[0-9]{4,8}$

    Identifies the PIN code.

  • puk1 string

    Possible values: Value must match regular expression ^[0-9]{8}$

    Identifies the PUK code.

  • puk2 string

    Possible values: Value must match regular expression ^[0-9]{8}$

    Identifies the PUK code.

  • servicePolicy object

    References a service policy that is related to this resource. The url property can be used to GET the resource. The attributes property will be omitted unless the query parameter specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

  • url string

    Possible values: non-empty and <= 256 characters

  • attributes object

    Attributes present in the response depends on service policy type.

    oneOf
  • id string

    Possible values: Value must match regular expression ^22[A-HJ-NP-Z2-9]{6}$

    Identifies the service policy.

  • domainId string

    Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

    Domain the resource belongs to. Used to determine which users have access to the resource.

  • name string

    Possible values: non-empty and <= 256 characters

    Name of the service policy.

  • metadata object

    All metadata key-value pairs associated with this service policy. This object contains dynamic properties since metadata has a customized definition process.

  • type string

    Possible values: [IOTA_SERVICE_POLICY, THINGSPACE_SERVICE_POLICY]

    Specifies the underlying service policy type in the Connectivity Management Platform (CMP).

Loading...