API Overview Resources Schemas

Schemas

DateTime

1

"2023-01-01T00:00:00Z"

Name	Type	Required	Description
anonymous	string(date-time)	false	Date and time. Format according to ISO 8601

HealthResponse

1
2
3
4


{
  "persistence": "pass",
  "global": "pass"
}

Name	Type	Required	Description
persistence	string	false	Database connectivity status
global	string	false	Overall service health status

Property	Values
persistence	one of [pass, fail]
global	one of [pass, fail]

ErrorResponse

1
2
3
4
5
6
7


{
  "error": {
    "code": "ERROR_CODE",
    "message": "Error message",
    "reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
  }
}

Name	Type	Required	Description
error	ErrorDetails	true	none

ErrorDetails

1
2
3
4
5


{
  "code": "ERROR_CODE",
  "message": "Error message",
  "reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}

Name	Type	Required	Description
code	string	true	Error code
message	string	true	Human-readable error message
reference	string(uri)	true	Link to error documentation

SubscriptionType

1

"MAX"

Name	Type	Required	Description
anonymous	string	false	Subscription type

SubscriptionBase

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "MAX",
  "status": "ACTIVE",
  "activation_date": "string",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "last_status_update": "string",
  "last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
  "last_updated_date": "string",
  "catalogue_commercial_product_id": "7125",
  "legacy_account_id": 245655,
  "account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "creation_date": "string",
  "creation_user": "migration.user@masmovil.com",
  "creation_system": "rfm-migration-system",
  "deactivation_user": "admin.user@masmovil.com",
  "deactivation_system": "admin-portal",
  "add_ons": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_add_on_id": "124",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "string",
      "status": "CANCELLED",
      "activation_date": "string",
      "deactivation_date": "string",
      "deactivation_system": "killflex.auth.masmovil.com",
      "deactivation_user": "john.doe@masorange.es"
    }
  ],
  "free_units_packages": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_free_units_packages_id": "124",
      "activation_date": "string",
      "deactivation_date": "2025-01-05T03:30:15Z"
    }
  ],
  "devices_related_info": {
    "devices": [
      {
        "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
        "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
        "catalogue_device_id": "P09712MRC",
        "shipping_order_id": "18395",
        "pickup_order_id": "P0000001",
        "serial_number": "9876543-AB-345",
        "mac_address": "00-B0-D0-63-C2-26",
        "acquisition_type": "BORROWED",
        "commitments": [
          {
            "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
            "legacy_id": 345,
            "catalogue_id": "string",
            "expiration_date": "string",
            "cancellation_date": "string",
            "cancellation_system": "killflex.auth.masmovil.com",
            "cancellation_user": "john.doe@masorange.es",
            "creation_date": "string",
            "creation_system": "killflex.auth.masmovil.com"
          }
        ]
      }
    ],
    "delivery_info": {
      "delivery_type": "CUSTOMER_ADDRESS",
      "dealer_code": "1234"
    }
  },
  "bundle_related_info": {
    "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
    "legacy_id": 790224234,
    "catalogue_bundled_product_id": "8342",
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_XP",
    "mandatory": true
  },
  "promotions": [
    {
      "catalogue_promotion_id": "1572",
      "creation_date": "string",
      "creation_user": "migration.user@masmovil.com",
      "creation_system": "rfm-migration-system",
      "status": "ACTIVE",
      "activation_date": "string",
      "expiration_date": "2025-01-05T03:30:15Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "deactivation_user": "admin.user@masmovil.com",
      "deactivation_system": "admin-portal",
      "status_detail": "AUTOMATICALLY_REMOVED",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "catalogue_id": "string",
          "expiration_date": "string",
          "cancellation_date": "string",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es",
          "creation_date": "string",
          "creation_system": "killflex.auth.masmovil.com"
        }
      ]
    }
  ],
  "bundles_history": [
    {
      "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_bundle_id": 790224234,
      "last_status_reason": "BUNDLE_MIGRATION",
      "catalogue_bundled_product_id": "8342",
      "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
      "catalogue_commercial_product_id": "7125",
      "start_date": "string",
      "end_date": "2025-01-05T03:30:15Z",
      "mandatory": true
    }
  ]
}

Name	Type	Required	Description
id	string(uuid)	false	Unique identifier of the subscription
type	SubscriptionType	false	Subscription type
status	string	true	Subscription status
activation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Activation date and time. - Required if status is ACTIVE or DEACTIVATED - Must be null if status is CANCELLED

Name	Type	Required	Description
deactivation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Deactivation date and time. - Required if status is DEACTIVATED - Must be null if status is ACTIVE and CANCELLED

Name	Type	Required	Description
last_status_update	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Last status update date and time

Name	Type	Required	Description
last_status_reason	string	true	Reason for the last status update according to defined values. Check possible values in status table in https://developers.masstack.com/en/guides/subscriptions/lifecycle
last_updated_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Date and time when any field of the subscription was last updated

Name	Type	Required	Description
catalogue_commercial_product_id	string	true	Commercial product ID according to catalogue definition
legacy_account_id	integer	true	Legacy account id the subscription is linked to
account_id	string(uuid)	false	Unique identifier of the account
creation_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Subscription creation date and time

Name	Type	Required	Description
creation_user	string	true	User who created the subscription
creation_system	string	false	System that created the subscription
deactivation_user	string	false	User who deactivated the subscription (if applicable)
deactivation_system	string	false	System that deactivated the subscription (if applicable)
add_ons	[AddOn]	false	Ids of subscription applicable add-ons(value added services) according to catalogue definition
free_units_packages	[FreeUnitsPackage]	false	Ids of free units packages according to catalogue definition
devices_related_info	DevicesRelatedInfo	false	Info about devices associated to the subscription
bundle_related_info	BundleRelatedInfo	true	Bundle relation information for subscription migration
promotions	[Promotion]	false	Array of promotions associated to the subscription
bundles_history	[SubscriptionBundleHistory]	false	Historical bundle changes for the subscription

Property	Values
status	one of [ACTIVE, DEACTIVATED, CANCELLED]

AddOn

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_id": 457345,
  "catalogue_add_on_id": "124",
  "creation_date": "string",
  "creation_system": "killflex.auth.masmovil.com",
  "creation_user": "john.doe@masorange.es",
  "last_updated_date": "string",
  "status": "CANCELLED",
  "activation_date": "string",
  "deactivation_date": "string",
  "deactivation_system": "killflex.auth.masmovil.com",
  "deactivation_user": "john.doe@masorange.es"
}

Name	Type	Required	Description
id	string	false	Add-on unique identifier
legacy_id	integer	false	Legacy add-on id linked to MySim/Apollo storage
catalogue_add_on_id	string	true	Catalogue add-on ID
creation_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	add-on creation date

Name	Type	Required	Description
creation_system	string	false	Info about the system that requested the addOn creation. It contains the mas-stack authentication audience info. N/A if not available
creation_user	string	true	Info about the specific user that requested the addON creation. N/A if not available
last_updated_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Date and time when any field of the addOn was last updated

Name	Type	Required	Description
status	string	true	add-on status
activation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	add-on activation date

Name	Type	Required	Description
deactivation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	add-on deactivation date

Name	Type	Required	Description
deactivation_system	string	false	none
deactivation_user	string	false	Info about the specific user that requested the addOn deactivation. It contains the mas-stack authentication subject info when deactivation was requested by mas-stack authenticated user, other user info for legacy systems deactivations if available or N/A otherwise

Property	Values
status	one of [REQUESTED, ACTIVE, CANCELLED, DEACTIVATED]

FreeUnitsPackage

1
2
3
4
5
6
7


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_id": 457345,
  "catalogue_free_units_packages_id": "124",
  "activation_date": "string",
  "deactivation_date": "2025-01-05T03:30:15Z"
}

Name	Type	Required	Description
id	string	false	Assigned Free Units Package ID
legacy_id	integer	false	Assigned Free Units Package legacy ID
catalogue_free_units_packages_id	string	true	Catalogue free units packages ID
activation_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Activation date and time of the package

Name	Type	Required	Description
deactivation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Deactivation date and time of the package

BundleRelatedInfo

1
2
3
4
5
6
7


{
  "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
  "legacy_id": 790224234,
  "catalogue_bundled_product_id": "8342",
  "catalogue_bundled_commercial_product_id": "8432_BUNDLED_XP",
  "mandatory": true
}

Name	Type	Required	Description
id	string(uuid)	false	Unique identifier of the bundle the subscription is included in
legacy_id	integer	true	Legacy unique identifier of the bundle the subscription is included in
catalogue_bundled_product_id	string	true	Bundle product id according to catalogue definition
catalogue_bundled_commercial_product_id	string	true	Bundle commercial product id associated to subscription according to catalogue definition
mandatory	boolean	true	Indicates if subscription is mandatory for the bundle

Promotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26


{
  "catalogue_promotion_id": "1572",
  "creation_date": "string",
  "creation_user": "migration.user@masmovil.com",
  "creation_system": "rfm-migration-system",
  "status": "ACTIVE",
  "activation_date": "string",
  "expiration_date": "2025-01-05T03:30:15Z",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "deactivation_user": "admin.user@masmovil.com",
  "deactivation_system": "admin-portal",
  "status_detail": "AUTOMATICALLY_REMOVED",
  "commitments": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 345,
      "catalogue_id": "string",
      "expiration_date": "string",
      "cancellation_date": "string",
      "cancellation_system": "killflex.auth.masmovil.com",
      "cancellation_user": "john.doe@masorange.es",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com"
    }
  ]
}

Name	Type	Required	Description
catalogue_promotion_id	string	true	Catalogue promotion ID
creation_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Promotion creation date

Name	Type	Required	Description
creation_user	string	true	User who created the promotion
creation_system	string	false	System that created the promotion
status	string	true	Promotion status
activation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Promotion activation date

Name	Type	Required	Description
expiration_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Promotion expiration date

Name	Type	Required	Description
deactivation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Promotion deactivation date

Name	Type	Required	Description
deactivation_user	string	false	User who deactivated the promotion
deactivation_system	string	false	System that deactivated the promotion
status_detail	string	false	Additional status details
commitments	[Commitment]	false	Commitments associated to the promotion

Property	Values
status	one of [ACTIVE, DEACTIVATED, EXPIRED]

SubscriptionBundleHistory

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_bundle_id": 790224234,
  "last_status_reason": "BUNDLE_MIGRATION",
  "catalogue_bundled_product_id": "8342",
  "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
  "catalogue_commercial_product_id": "7125",
  "start_date": "string",
  "end_date": "2025-01-05T03:30:15Z",
  "mandatory": true
}

Name	Type	Required	Description
bundle_id	string(uuid)	false	Unique identifier of the bundle
legacy_bundle_id	integer	true	Legacy unique identifier of the bundle the subscription is included in
last_status_reason	string	true	Reason for bundle change
catalogue_bundled_product_id	string	true	Bundle product ID according to catalogue definition
catalogue_bundled_commercial_product_id	string	true	Bundle commercial product ID according to catalogue definition
catalogue_commercial_product_id	string	true	Commercial product ID according to catalogue definition
start_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Date and time when the subscription was added to the bundle

Name	Type	Required	Description
end_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Date and time when the subscription was removed from the bundle

Name	Type	Required	Description
mandatory	boolean	false	Indicates if subscription is mandatory for the bundle

Commitment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_id": 345,
  "catalogue_id": "string",
  "expiration_date": "string",
  "cancellation_date": "string",
  "cancellation_system": "killflex.auth.masmovil.com",
  "cancellation_user": "john.doe@masorange.es",
  "creation_date": "string",
  "creation_system": "killflex.auth.masmovil.com"
}

Name	Type	Required	Description
id	string(uuid)	false	Acquired commitment id
legacy_id	integer	false	Legacy id for acquired commitment linked MySim/Apollo storage, to be deprecated but required when catalogue_term_id not available
catalogue_id	string	false	Catalogue Commitment ID
expiration_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	End date

Name	Type	Required	Description
cancellation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Cancellation date

Name	Type	Required	Description
cancellation_system	string	false	Info about the system that requested the commitment cancellation. It contains the mas-stack authentication audience info. N/A if not available
cancellation_user	string	false	Info about the specific user that requested the commitment cancellation. N/A if not available
creation_date	any	false	none

Name	Type	Required	Description
» anonymous	DateTime	false	Date and time. Format according to ISO 8601

Name	Type	Required	Description
» anonymous	any	false	Commitment creation date

Name	Type	Required	Description
creation_system	string	false	Info about the system that requested the commitment creation. It contains the mas-stack authentication audience info. N/A if not available

Device

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
  "catalogue_device_id": "P09712MRC",
  "shipping_order_id": "18395",
  "pickup_order_id": "P0000001",
  "serial_number": "9876543-AB-345",
  "mac_address": "00-B0-D0-63-C2-26",
  "acquisition_type": "BORROWED",
  "commitments": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 345,
      "catalogue_id": "string",
      "expiration_date": "string",
      "cancellation_date": "string",
      "cancellation_system": "killflex.auth.masmovil.com",
      "cancellation_user": "john.doe@masorange.es",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com"
    }
  ]
}

Name	Type	Required	Description
id	string(uuid)	false	Device unique identifier
catalogue_commercial_device_id	string	true	Commercial device id according to catalogue definition
catalogue_device_id	string	false	Device id according to catalogue definition
shipping_order_id	string	false	Id of the shipping order related to the device according to logistic
pickup_order_id	string	false	Id of the pickup order related to the device according to reverse logistic
serial_number	string	false	The serial number or any alphanumeric identifier of a particular device
mac_address	string	false	A unique identifier assigned to the device network interface controller
acquisition_type	string	false	Specifies the type of acquisition for the device
commitments	[Commitment]	false	none

Property	Values
acquisition_type	one of [BORROWED, FINANCED, ONE_TIME_PAYMENT]

DevicesRelatedInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31


{
  "devices": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
      "catalogue_device_id": "P09712MRC",
      "shipping_order_id": "18395",
      "pickup_order_id": "P0000001",
      "serial_number": "9876543-AB-345",
      "mac_address": "00-B0-D0-63-C2-26",
      "acquisition_type": "BORROWED",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "catalogue_id": "string",
          "expiration_date": "string",
          "cancellation_date": "string",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es",
          "creation_date": "string",
          "creation_system": "killflex.auth.masmovil.com"
        }
      ]
    }
  ],
  "delivery_info": {
    "delivery_type": "CUSTOMER_ADDRESS",
    "dealer_code": "1234"
  }
}

Name	Type	Required	Description
devices	[Device]	false	[Devices associated to the subscription]
delivery_info	object	false	Info to grant delivery of devices
» delivery_type	string	false	Delivery type
» dealer_code	string	false	Dealer the store is associated to. Required if delivery_type is SHOP

Property	Values
delivery_type	one of [SHOP, POST_OFFICE, CUSTOMER_ADDRESS, UNKNOWN]

CreateCreditLimitsRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "subscription_type": "MOBILE",
  "credit_limits": [
    {
      "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
      "credit_limit_value": 300,
      "reason": "rfm krt migration"
    }
  ]
}

Name	Type	Required	Description
subscription_type	string	true	Type of subscription
credit_limits	[CreditLimit]	true	Array of credit limits to create

Property	Values
subscription_type	one of [MOBILE, LANDLINE]

CreditLimit

1
2
3
4
5


{
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 300,
  "reason": "rfm krt migration"
}

Name	Type	Required	Description
credit_limit_id	string	true	Type of credit limit
credit_limit_value	number(double)	true	Credit limit value in currency units
reason	string	true	Reason for setting this credit limit

Property	Values
credit_limit_id	one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT]

CreateSegmentRequest

1
2
3
4
5


{
  "segment_id": "DEVICEOFFERSEGMENT",
  "segment_value": "PREMIUM",
  "reason": "rfm krt"
}

Name	Type	Required	Description
segment_id	string	true	Segment identifier (must match pattern based on subscription type - OM% for postpaid mobile, OP% for prepaid, OC% for convergent)
segment_value	string	true	Segment value
reason	string	true	Reason for segment creation

Max

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "MAX",
  "status": "ACTIVE",
  "activation_date": "string",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "last_status_update": "string",
  "last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
  "last_updated_date": "string",
  "catalogue_commercial_product_id": "7125",
  "legacy_account_id": 245655,
  "account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "creation_date": "string",
  "creation_user": "migration.user@masmovil.com",
  "creation_system": "rfm-migration-system",
  "deactivation_user": "admin.user@masmovil.com",
  "deactivation_system": "admin-portal",
  "add_ons": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_add_on_id": "124",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "string",
      "status": "CANCELLED",
      "activation_date": "string",
      "deactivation_date": "string",
      "deactivation_system": "killflex.auth.masmovil.com",
      "deactivation_user": "john.doe@masorange.es"
    }
  ],
  "free_units_packages": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_free_units_packages_id": "124",
      "activation_date": "string",
      "deactivation_date": "2025-01-05T03:30:15Z"
    }
  ],
  "devices_related_info": {
    "devices": [
      {
        "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
        "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
        "catalogue_device_id": "P09712MRC",
        "shipping_order_id": "18395",
        "pickup_order_id": "P0000001",
        "serial_number": "9876543-AB-345",
        "mac_address": "00-B0-D0-63-C2-26",
        "acquisition_type": "BORROWED",
        "commitments": [
          {
            "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
            "legacy_id": 345,
            "catalogue_id": "string",
            "expiration_date": "string",
            "cancellation_date": "string",
            "cancellation_system": "killflex.auth.masmovil.com",
            "cancellation_user": "john.doe@masorange.es",
            "creation_date": "string",
            "creation_system": "killflex.auth.masmovil.com"
          }
        ]
      }
    ],
    "delivery_info": {
      "delivery_type": "CUSTOMER_ADDRESS",
      "dealer_code": "1234"
    }
  },
  "bundle_related_info": {
    "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
    "legacy_id": 790224234,
    "catalogue_bundled_product_id": "8342",
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_XP",
    "mandatory": true
  },
  "promotions": [
    {
      "catalogue_promotion_id": "1572",
      "creation_date": "string",
      "creation_user": "migration.user@masmovil.com",
      "creation_system": "rfm-migration-system",
      "status": "ACTIVE",
      "activation_date": "string",
      "expiration_date": "2025-01-05T03:30:15Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "deactivation_user": "admin.user@masmovil.com",
      "deactivation_system": "admin-portal",
      "status_detail": "AUTOMATICALLY_REMOVED",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "catalogue_id": "string",
          "expiration_date": "string",
          "cancellation_date": "string",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es",
          "creation_date": "string",
          "creation_system": "killflex.auth.masmovil.com"
        }
      ]
    }
  ],
  "bundles_history": [
    {
      "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_bundle_id": 790224234,
      "last_status_reason": "BUNDLE_MIGRATION",
      "catalogue_bundled_product_id": "8342",
      "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
      "catalogue_commercial_product_id": "7125",
      "start_date": "string",
      "end_date": "2025-01-05T03:30:15Z",
      "mandatory": true
    }
  ],
  "specific_data": {
    "service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "product_id": "beam-max-svod-monthly"
  }
}

Name	Type	Required	Description
anonymous	SubscriptionBase	false	Base structure for subscription migration

Name	Type	Required	Description
anonymous	object	false	none
» specific_data	MaxSpecificData	true	Max subscription specific data for migration

MaxSpecificData

1
2
3
4


{
  "service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
  "product_id": "beam-max-svod-monthly"
}

Name	Type	Required	Description
service_id	string	true	Max internal ID that identifies the subscription
product_id	string	true	Max product ID according to catalog definition

Disney

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "MAX",
  "status": "ACTIVE",
  "activation_date": "string",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "last_status_update": "string",
  "last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
  "last_updated_date": "string",
  "catalogue_commercial_product_id": "7125",
  "legacy_account_id": 245655,
  "account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "creation_date": "string",
  "creation_user": "migration.user@masmovil.com",
  "creation_system": "rfm-migration-system",
  "deactivation_user": "admin.user@masmovil.com",
  "deactivation_system": "admin-portal",
  "add_ons": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_add_on_id": "124",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "string",
      "status": "CANCELLED",
      "activation_date": "string",
      "deactivation_date": "string",
      "deactivation_system": "killflex.auth.masmovil.com",
      "deactivation_user": "john.doe@masorange.es"
    }
  ],
  "free_units_packages": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_free_units_packages_id": "124",
      "activation_date": "string",
      "deactivation_date": "2025-01-05T03:30:15Z"
    }
  ],
  "devices_related_info": {
    "devices": [
      {
        "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
        "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
        "catalogue_device_id": "P09712MRC",
        "shipping_order_id": "18395",
        "pickup_order_id": "P0000001",
        "serial_number": "9876543-AB-345",
        "mac_address": "00-B0-D0-63-C2-26",
        "acquisition_type": "BORROWED",
        "commitments": [
          {
            "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
            "legacy_id": 345,
            "catalogue_id": "string",
            "expiration_date": "string",
            "cancellation_date": "string",
            "cancellation_system": "killflex.auth.masmovil.com",
            "cancellation_user": "john.doe@masorange.es",
            "creation_date": "string",
            "creation_system": "killflex.auth.masmovil.com"
          }
        ]
      }
    ],
    "delivery_info": {
      "delivery_type": "CUSTOMER_ADDRESS",
      "dealer_code": "1234"
    }
  },
  "bundle_related_info": {
    "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
    "legacy_id": 790224234,
    "catalogue_bundled_product_id": "8342",
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_XP",
    "mandatory": true
  },
  "promotions": [
    {
      "catalogue_promotion_id": "1572",
      "creation_date": "string",
      "creation_user": "migration.user@masmovil.com",
      "creation_system": "rfm-migration-system",
      "status": "ACTIVE",
      "activation_date": "string",
      "expiration_date": "2025-01-05T03:30:15Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "deactivation_user": "admin.user@masmovil.com",
      "deactivation_system": "admin-portal",
      "status_detail": "AUTOMATICALLY_REMOVED",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "catalogue_id": "string",
          "expiration_date": "string",
          "cancellation_date": "string",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es",
          "creation_date": "string",
          "creation_system": "killflex.auth.masmovil.com"
        }
      ]
    }
  ],
  "bundles_history": [
    {
      "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_bundle_id": 790224234,
      "last_status_reason": "BUNDLE_MIGRATION",
      "catalogue_bundled_product_id": "8342",
      "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
      "catalogue_commercial_product_id": "7125",
      "start_date": "string",
      "end_date": "2025-01-05T03:30:15Z",
      "mandatory": true
    }
  ],
  "specific_data": {
    "user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "product_id": "beam-max-svod-monthly"
  }
}

Name	Type	Required	Description
anonymous	SubscriptionBase	false	Base structure for subscription migration

Name	Type	Required	Description
anonymous	object	false	none
» specific_data	DisneySpecificData	true	Disney subscription specific data for migration

DisneySpecificData

1
2
3
4
5


{
  "user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
  "service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
  "product_id": "beam-max-svod-monthly"
}

Name	Type	Required	Description
user_id	string	true	Disney internal ID that identifies the user
service_id	string	true	Disney internal ID that identifies the subscription
product_id	string	true	Disney product ID according to catalog definition

AmazonPrime

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "MAX",
  "status": "ACTIVE",
  "activation_date": "string",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "last_status_update": "string",
  "last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
  "last_updated_date": "string",
  "catalogue_commercial_product_id": "7125",
  "legacy_account_id": 245655,
  "account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "creation_date": "string",
  "creation_user": "migration.user@masmovil.com",
  "creation_system": "rfm-migration-system",
  "deactivation_user": "admin.user@masmovil.com",
  "deactivation_system": "admin-portal",
  "add_ons": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_add_on_id": "124",
      "creation_date": "string",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "string",
      "status": "CANCELLED",
      "activation_date": "string",
      "deactivation_date": "string",
      "deactivation_system": "killflex.auth.masmovil.com",
      "deactivation_user": "john.doe@masorange.es"
    }
  ],
  "free_units_packages": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_free_units_packages_id": "124",
      "activation_date": "string",
      "deactivation_date": "2025-01-05T03:30:15Z"
    }
  ],
  "devices_related_info": {
    "devices": [
      {
        "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
        "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
        "catalogue_device_id": "P09712MRC",
        "shipping_order_id": "18395",
        "pickup_order_id": "P0000001",
        "serial_number": "9876543-AB-345",
        "mac_address": "00-B0-D0-63-C2-26",
        "acquisition_type": "BORROWED",
        "commitments": [
          {
            "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
            "legacy_id": 345,
            "catalogue_id": "string",
            "expiration_date": "string",
            "cancellation_date": "string",
            "cancellation_system": "killflex.auth.masmovil.com",
            "cancellation_user": "john.doe@masorange.es",
            "creation_date": "string",
            "creation_system": "killflex.auth.masmovil.com"
          }
        ]
      }
    ],
    "delivery_info": {
      "delivery_type": "CUSTOMER_ADDRESS",
      "dealer_code": "1234"
    }
  },
  "bundle_related_info": {
    "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
    "legacy_id": 790224234,
    "catalogue_bundled_product_id": "8342",
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_XP",
    "mandatory": true
  },
  "promotions": [
    {
      "catalogue_promotion_id": "1572",
      "creation_date": "string",
      "creation_user": "migration.user@masmovil.com",
      "creation_system": "rfm-migration-system",
      "status": "ACTIVE",
      "activation_date": "string",
      "expiration_date": "2025-01-05T03:30:15Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "deactivation_user": "admin.user@masmovil.com",
      "deactivation_system": "admin-portal",
      "status_detail": "AUTOMATICALLY_REMOVED",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "catalogue_id": "string",
          "expiration_date": "string",
          "cancellation_date": "string",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es",
          "creation_date": "string",
          "creation_system": "killflex.auth.masmovil.com"
        }
      ]
    }
  ],
  "bundles_history": [
    {
      "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_bundle_id": 790224234,
      "last_status_reason": "BUNDLE_MIGRATION",
      "catalogue_bundled_product_id": "8342",
      "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
      "catalogue_commercial_product_id": "7125",
      "start_date": "string",
      "end_date": "2025-01-05T03:30:15Z",
      "mandatory": true
    }
  ],
  "specific_data": {
    "entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "tier_id": "prime_3_months_promo",
    "product_id": "PRIME_3M_PROMO"
  }
}

Name	Type	Required	Description
anonymous	SubscriptionBase	false	Base structure for subscription migration

Name	Type	Required	Description
anonymous	object	false	none
» specific_data	AmazonPrimeSpecificData	true	Amazon Prime subscription specific data for migration

AmazonPrimeSpecificData

1
2
3
4
5
6


{
  "entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
  "bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
  "tier_id": "prime_3_months_promo",
  "product_id": "PRIME_3M_PROMO"
}

Name	Type	Required	Description
entitlement_id	string	true	Amazon Prime entitlement ID
bundle_id	string	true	Amazon Prime bundle ID
tier_id	string	true	Amazon Prime tier ID
product_id	string	true	Amazon Prime product ID according to catalog definition