profile-telecom-subscription.schema.md

Telecom Subscription Schema

https://ns.adobe.com/xdm/mixins/profile/profile-telecom-subscription

Collects all generic details related to a customer's telecom subscription plan, including pricing, packages, and individual product subscriptions.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	fieldgroups/profile/profile-telecom-subscription.schema.json

Telecom Subscription Example

{}

Telecom Subscription Properties

Property	Type	Required	Defined by
xdm:telecomSubscription	object	Optional	Telecom Subscription (this schema)
*	any	Additional	this schema allows additional properties

xdm:telecomSubscription

xdm:telecomSubscription

• is optional
• type: object
• defined in this schema

xdm:telecomSubscription Type

object with following properties:

Property	Type	Required
xdm:bundleName	string	Optional
xdm:internetSubscription	array	Optional
xdm:landlineSubscription	array	Optional
xdm:mediaSubscription	array	Optional
xdm:mobileSubscription	array	Optional
xdm:primaryPartyID	string	Optional
xdm:primarySubscriber		Optional

xdm:bundleName

Bundle Name

Captures the name of any type of subscription bundle in which the customer is enrolled, such as 'Internet + Media'.

xdm:bundleName

• is optional
• type: string

xdm:bundleName Type

string

xdm:internetSubscription

Internet subscription plan details such as data cap, connection type, and speed details.

xdm:internetSubscription

• is optional
• type: object[]

xdm:internetSubscription Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
xdm:connectionType	string	Optional
xdm:dataCap	integer	Optional
xdm:downloadSpeed	integer	Optional
xdm:selfSetup	boolean	Optional
xdm:subscriptionDetails		Optional
xdm:uploadSpeed	integer	Optional

xdm:connectionType

Connection Type

Tracks the type of connection type for the subscription.

xdm:connectionType

• is optional
• type: enum

The value of this property must be equal to one of the known values below.

xdm:connectionType Known Values

Value	Description
cable	Cable
dsl	DSL
fiber	Fiber
mobile	Mobile
satellite	Satellite

xdm:dataCap

Data Cap

Captures the data cap limit for the account, in megabytes (MB).

xdm:dataCap

• is optional
• type: integer

xdm:dataCap Type

integer

xdm:downloadSpeed

Download Speed

Records the maximum download speed available for the subscription, in megabytes (MB).

xdm:downloadSpeed

• is optional
• type: integer

xdm:downloadSpeed Type

integer

xdm:selfSetup

Self-Setup

Flags if a customer is eligible for internet setup without a technican visit.

xdm:selfSetup

• is optional
• type: boolean

xdm:selfSetup Type

boolean

xdm:subscriptionDetails

Subscription Details

Extension of the subscription data type to include subscription length, fees, status, etc.

xdm:subscriptionDetails

• is optional
• type: reference

xdm:subscriptionDetails Type

• – https://ns.adobe.com/xdm/datatypes/telecom-subscription

xdm:uploadSpeed

Upload Speed

Records the maximum upload speed available for the subscription, in megabytes (MB).

xdm:uploadSpeed

• is optional
• type: integer

xdm:uploadSpeed Type

integer

xdm:landlineSubscription

Landline subscription plan details including selected features, minutes, and dialing plans.

xdm:landlineSubscription

• is optional
• type: object[]

xdm:landlineSubscription Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
xdm:callBlocking	boolean	Optional
xdm:callForwarding	boolean	Optional
xdm:callWaiting	boolean	Optional
xdm:callerID	boolean	Optional
xdm:internationalCalling	boolean	Optional
xdm:minutes	integer	Optional
xdm:phoneNumber		Optional
xdm:subscriptionDetails		Optional
xdm:threeWayCalling	boolean	Optional
xdm:unlimitedDomesticLongDistance	boolean	Optional
xdm:unlimitedLocalCalling	boolean	Optional
xdm:voicemail	boolean	Optional

xdm:callBlocking

Call Blocking

Flags if the landline subscription features include Call Blocking.

xdm:callBlocking

• is optional
• type: boolean

xdm:callBlocking Type

boolean

xdm:callForwarding

Call Forwarding

Flags if the landline subscription features include Call Forwarding.

xdm:callForwarding

• is optional
• type: boolean

xdm:callForwarding Type

boolean

xdm:callWaiting

Call Waiting

Flags if the landline subscription features include Call Waiting.

xdm:callWaiting

• is optional
• type: boolean

xdm:callWaiting Type

boolean

xdm:callerID

Caller ID

Flags if the landline subscription features include Caller ID.

xdm:callerID

• is optional
• type: boolean

xdm:callerID Type

boolean

xdm:internationalCalling

International Calling

Flags if the landline subscription features include International Calling.

xdm:internationalCalling

• is optional
• type: boolean

xdm:internationalCalling Type

boolean

xdm:minutes

Minutes

Number of monthly minutes available within the subscription.

xdm:minutes

• is optional
• type: integer

xdm:minutes Type

integer

xdm:phoneNumber

Phone Number

Captures the phone number assigned to this device.

xdm:phoneNumber

• is optional
• type: reference

xdm:phoneNumber Type

• – https://ns.adobe.com/xdm/context/phonenumber

xdm:subscriptionDetails

Subscription Details

Extension of the subscription data type to include subscription length, fees, status, etc.

xdm:subscriptionDetails

• is optional
• type: reference

xdm:subscriptionDetails Type

• – https://ns.adobe.com/xdm/datatypes/telecom-subscription

xdm:threeWayCalling

Three-Way Dialing

Flags if the landline subscription features include Three-Way Dialing.

xdm:threeWayCalling

• is optional
• type: boolean

xdm:threeWayCalling Type

boolean

xdm:unlimitedDomesticLongDistance

Unlimited Domestic Long Distance

Flags if the landline subscription features include Unlimited Domestic Long Distance.

xdm:unlimitedDomesticLongDistance

• is optional
• type: boolean

xdm:unlimitedDomesticLongDistance Type

boolean

xdm:unlimitedLocalCalling

Unlimited Local Calling

Flags if the landline subscription features include Unlimited Local Calling.

xdm:unlimitedLocalCalling

• is optional
• type: boolean

xdm:unlimitedLocalCalling Type

boolean

xdm:voicemail

Voicemail

Flags if the landline subscription features include Voicemail.

xdm:voicemail

• is optional
• type: boolean

xdm:voicemail Type

boolean

xdm:mediaSubscription

media subscription plan details including number of channels & included streaming services.

xdm:mediaSubscription

• is optional
• type: object[]

xdm:mediaSubscription Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
xdm:channels	integer	Optional
xdm:streamingServices	array	Optional
xdm:subscriptionDetails		Optional

xdm:channels

Channels

Records the number of channels included with the media subscription.

xdm:channels

• is optional
• type: integer

xdm:channels Type

integer

xdm:streamingServices

Streaming Services

Array of all streaming services included with the subscription.

xdm:streamingServices

• is optional
• type: object[]

xdm:streamingServices Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
xdm:promotionLength	integer	Optional
xdm:promotionalAddition	boolean	Optional
xdm:serviceName	integer	Optional

xdm:promotionLength

Promotion Length

Tracks the length of the promotion, in months, if the streaming service was added as part of a promotion.

xdm:promotionLength

• is optional
• type: integer

xdm:promotionLength Type

integer

xdm:promotionalAddition

Promotional Addition

Flags if the streaming service was added as part of a promotion.

xdm:promotionalAddition

• is optional
• type: boolean

xdm:promotionalAddition Type

boolean

xdm:serviceName

Service Name

Records the name of the streaming service.

xdm:serviceName

• is optional
• type: integer

xdm:serviceName Type

integer

xdm:subscriptionDetails

Subscription Details

Extension of the subscription data type to include subscription length, fees, status, etc.

xdm:subscriptionDetails

• is optional
• type: reference

xdm:subscriptionDetails Type

• – https://ns.adobe.com/xdm/datatypes/telecom-subscription

xdm:mobileSubscription

Mobile plan details including number of lines, data rates, cost, etc.

xdm:mobileSubscription

• is optional
• type: object[]

xdm:mobileSubscription Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
xdm:earlyUpgradeEnrollment	boolean	Optional
xdm:phoneNumber		Optional
xdm:planLevel	string	Optional
xdm:portedNumber	boolean	Optional
xdm:subscriptionDetails		Optional

xdm:earlyUpgradeEnrollment

Early Upgrade Enrollment

Captures if the customer opts into early upgrades.

xdm:earlyUpgradeEnrollment

• is optional
• type: boolean

xdm:earlyUpgradeEnrollment Type

boolean

xdm:phoneNumber

Phone Number

Captures the phone number assigned to this device.

xdm:phoneNumber

• is optional
• type: reference

xdm:phoneNumber Type

• – https://ns.adobe.com/xdm/context/phonenumber

xdm:planLevel

Plan Level

Captures the name of the mobile plan assigned to this device.

xdm:planLevel

• is optional
• type: string

xdm:planLevel Type

string

xdm:portedNumber

Ported Number

Captures if the customer ports their number from another carrier.

xdm:portedNumber

• is optional
• type: boolean

xdm:portedNumber Type

boolean

xdm:subscriptionDetails

Subscription Details

Extension of the subscription data type to include subscription length, fees, status, etc.

xdm:subscriptionDetails

• is optional
• type: reference

xdm:subscriptionDetails Type

• – https://ns.adobe.com/xdm/datatypes/telecom-subscription

xdm:primaryPartyID

Primary Party ID

Identifier for the primary person responsible for the subscription, which typically could be their device phone number.

xdm:primaryPartyID

• is optional
• type: string

xdm:primaryPartyID Type

string

xdm:primarySubscriber

Primary Subscriber

The owner of the subscription.

xdm:primarySubscriber

• is optional
• type: reference

xdm:primarySubscriber Type

• – https://ns.adobe.com/xdm/context/person