API Overview Resources Schemas

Orange TV

Orange TV resource represents a Orange TV subscription containing specific Orange TV data besides all data applicable to any subscription

Add Orange TV subscription to a bundle

Add a new Orange TV subscription to a bundle with the provided data

POST /orgs/{org}/bundles/{bundleId}/subscriptions/orange_tv

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
bundleId	path	string(uuid)	true	Bundle identifier
body	body	OrangeTv	true	Orange TV subscription data

Request body - instance of OrangeTv

  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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175


{
  "specific_data": {
    "registration_email": "john.doe@mail.com",
    "service_id": "yoigo123456789",
    "product_id": "SP_OFFER_0200000"
  },
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_id": 54,
  "pre_scoring_id": "1564",
  "type": "NETFLIX",
  "catalogue_commercial_product_id": "7125",
  "status": "ACTIVE",
  "promotions": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_promotion_id": "124",
      "commitments": [
        {
          "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
          "legacy_id": 345,
          "expiration_date": "2025-01-05T03:30:15Z",
          "cancellation_date": "2025-02-13T10:35:05Z",
          "cancellation_system": "killflex.auth.masmovil.com",
          "cancellation_user": "john.doe@masorange.es"
        }
      ],
      "creation_date": "2022-12-01T00:00:00Z",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "2023-01-08T12:00:05Z",
      "status": "ACTIVE",
      "activation_date": "2023-01-01T00:00:00Z",
      "expiration_date": "2025-01-05T03:30:15Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "deactivation_system": "killflex.auth.masmovil.com",
      "deactivation_user": "john.doe@masorange.es",
      "origin": "EXISTING_CLIENT"
    }
  ],
  "add_ons": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 457345,
      "catalogue_add_on_legacy_id": "124",
      "catalogue_add_on_id": "124",
      "creation_date": "2022-12-01T00:00:00Z",
      "creation_system": "killflex.auth.masmovil.com",
      "creation_user": "john.doe@masorange.es",
      "last_updated_date": "2023-01-08T12:00:05Z",
      "status": "CANCELLED",
      "activation_date": "2023-01-01T00:00:00Z",
      "deactivation_date": "2025-01-05T03:30:15Z",
      "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": "2023-01-01T00:00:00Z",
      "deactivation_date": "2025-01-05T03:30:15Z"
    }
  ],
  "devices_related_info": {
    "devices": [
      {
        "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
        "legacy_id": 756402,
        "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
        "catalogue_device_id": "P09712MRC",
        "reservation_id": "1567",
        "signature_process_id": "18395",
        "shipping_order_id": "18395",
        "pickup_order_id": "P0000001",
        "in_store_delivery_date": "2025-01-05T03:30:15Z",
        "in_store_returned_date": "2025-01-05T03:30:15Z",
        "manufacturing_info": {
          "id_type": "SERIAL_NUMBER",
          "id": "9876543-AB-345"
        },
        "serial_number": "9876543-AB-345",
        "mac_address": "00-B0-D0-63-C2-26",
        "imei": "AA-BBBBBB-CCCCCC-D",
        "acquisition_type": "BORROWED",
        "commitments": [
          {
            "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
            "legacy_id": 345,
            "expiration_date": "2025-01-05T03:30:15Z",
            "cancellation_date": "2025-02-13T10:35:05Z",
            "cancellation_system": "killflex.auth.masmovil.com",
            "cancellation_user": "john.doe@masorange.es"
          }
        ]
      }
    ],
    "customer_financial_info": {
      "bank_declared_income": 0,
      "business_name": "",
      "observations": "blabla",
      "professional_usage": false,
      "activity_country": "es",
      "doc_expiration_date": "2017-09-15T22:00:00Z",
      "profession_code": "PRIVATE_SECTOR_WORKER",
      "funds_origin_code": "3RD",
      "occupation_sector_code": "SERV"
    },
    "pre_booking": {
      "order_id": "123213asdsa",
      "authorization_id": "",
      "financial_entity": "BBVA",
      "agreed_commercial_consents": true,
      "agreed_gdpr": true,
      "status": "ACCEPTED",
      "granted_amount": 100,
      "credit_line_amount": 10
    },
    "delivery_info": {
      "contact_info": {
        "name": "Juan",
        "surname": "Perez Lopez",
        "id_doc": {
          "id_type": "NIF",
          "id": "5012341234"
        },
        "phone_number": "696288378",
        "email_address": "juan@hotmail.com"
      },
      "address": {
        "street_type": "Calle",
        "street_name": "Tellez",
        "house_number": "12",
        "additional_info": "Esc. Dcha 3 C",
        "city": "Riaza",
        "province": "Segovia",
        "country": "es",
        "post_code": "40500",
        "address_code": "28000010758100012    OA   004C       ",
        "address_additional_id": "123443554"
      },
      "delivery_type": "CUSTOMER_ADDRESS",
      "dealer_code": "1234"
    }
  },
  "last_status_update": "2023-01-05T03:30:15Z",
  "last_status_reason": "FRAUD_CHECK_ONGOING",
  "activation_date": "2023-01-01T00:00:00Z",
  "deactivation_date": "2025-01-05T03:30:15Z",
  "legacy_account_id": 245655,
  "account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "bundle_related_info": {
    "id": "abcf20cb-35df-4ffe-bca6-c0ed0c28cb00",
    "legacy_id": 790224234,
    "catalogue_bundled_product_id": "8342",
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
    "mandatory": true
  },
  "creation_date": "2022-12-01T00:00:00Z",
  "creation_system": "killflex.auth.masmovil.com",
  "creation_user": "john.doe@masmovil.com",
  "last_updated_date": "2023-01-08T12:00:05Z",
  "deactivation_system": "killflex.auth.masmovil.com",
  "deactivation_user": "john.doe@masmovil.com",
  "bundles_history": [
    {
      "bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_bundle_id": 54,
      "start_date": "2022-12-01T00:00:00Z",
      "end_date": "2023-01-05T03:30:15Z"
    }
  ]
}

Name	Type	Required	Description
specific_data	OrangeTvSpecificData	false	Orange TV subscription specific info

Name	Type	Required	Description
anonymous	Subscription	false	none

Name	Type	Required	Description
anonymous	object	false	none

Request example

  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



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/orange_tv \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'specific_data': {
    'registration_email': 'john.doe@mail.com'
  },
  'pre_scoring_id': '1564',
  'catalogue_commercial_product_id': '7125',
  'promotions': [
    {
      'catalogue_promotion_id': '124',
      'activation_date': '2023-01-01T00:00:00Z',
      'origin': 'EXISTING_CLIENT'
    }
  ],
  'add_ons': [
    {
      'catalogue_add_on_legacy_id': '124',
      'catalogue_add_on_id': '124'
    }
  ],
  'free_units_packages': [
    {
      'catalogue_free_units_packages_id': '124'
    }
  ],
  'devices_related_info': {
    'devices': [
      {
        'catalogue_commercial_device_id': 'CDCVPU_150f5badaa706651e67c59061d373d7e7e',
        'reservation_id': '1567',
        'signature_process_id': '18395',
        'manufacturing_info': {
          'id_type': 'SERIAL_NUMBER',
          'id': '9876543-AB-345'
        },
        'serial_number': '9876543-AB-345',
        'mac_address': '00-B0-D0-63-C2-26',
        'imei': 'AA-BBBBBB-CCCCCC-D',
        'commitments': [
          {}
        ]
      }
    ],
    'customer_financial_info': {
      'bank_declared_income': 0,
      'business_name': '',
      'observations': 'blabla',
      'professional_usage': false,
      'activity_country': 'es',
      'doc_expiration_date': '2017-09-15T22:00:00Z',
      'profession_code': 'PRIVATE_SECTOR_WORKER',
      'funds_origin_code': '3RD',
      'occupation_sector_code': 'SERV'
    },
    'pre_booking': {
      'order_id': '123213asdsa',
      'authorization_id': '',
      'financial_entity': 'BBVA',
      'agreed_commercial_consents': true,
      'agreed_gdpr': true,
      'status': 'ACCEPTED',
      'granted_amount': 100,
      'credit_line_amount': 10
    },
    'delivery_info': {
      'contact_info': {
        'name': 'Juan',
        'surname': 'Perez Lopez',
        'id_doc': {
          'id_type': 'NIF',
          'id': '5012341234'
        },
        'phone_number': '696288378',
        'email_address': 'juan@hotmail.com'
      },
      'address': {
        'street_type': 'Calle',
        'street_name': 'Tellez',
        'house_number': '12',
        'additional_info': 'Esc. Dcha 3 C',
        'city': 'Riaza',
        'province': 'Segovia',
        'country': 'es',
        'post_code': '40500',
        'address_code': '28000010758100012    OA   004C       ',
        'address_additional_id': '123443554'
      },
      'delivery_type': 'CUSTOMER_ADDRESS',
      'dealer_code': '1234'
    }
  },
  'bundle_related_info': {
    'catalogue_bundled_product_id': '8342',
    'catalogue_bundled_commercial_product_id': '8432_BUNDLED_3P',
    'mandatory': true
  }
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Orange TV subscription successfully added to the bundle	OrangeTv
400	Bad Request	Bad request	ErrorResponse
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A bundle with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get bundle Orange TV subscriptions

Returns an array of Orange TV subscriptions in a bundle

GET /orgs/{org}/bundles/{bundleId}/subscriptions/orange_tv

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
bundleId	path	string(uuid)	true	Bundle identifier
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
legacy_id	query	integer	false	Resource legacy ID
legacy_account_id	query	integer	false	Account id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_bundle_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
legacy_bundle_id	query	integer	false	Bundle id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_account_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
account_id	query	string	false	Account id the subscription is linked to. Required if ‘legacy_id’, ‘legacy_account_id’ or legacy_bundle_id filters are not provided.
mandatory	query	boolean	false	Mandatory subscription filter
status	query	SubscriptionStatusFilterEnum	false	Subscription status filter
type	query	SubscriptionType	false	Subscription type
activation_date	query	DateFilterEnum	false	Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
deactivation_date	query	DateFilterEnum	false	Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
registration_email	query	string	false	Registration email the subscription is linked to.
service_id	query	string	false	Provider service id the subscription is linked to.

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/orange_tv?offset='0'&limit='50'&legacy_id='0'&legacy_account_id='572234234'&legacy_bundle_id='26245435'&account_id='ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'&mandatory='true'&status={"eq":"ACTIVE","in":["ACTIVE"]}&type='NETFLIX'&activation_date='2023-01-05T03:30:15Z'&deactivation_date='2023-01-05T03:30:15Z'&registration_email='peter.sellers@monty.com'&service_id='masmovil003141592' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	OrangeTvSet
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A bundle with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Search Orange TV subscriptions

Search Orange TV subscriptions matching given criteria, at least one of the query params is required. Specific type data is included

GET /orgs/{org}/subscriptions/orange_tv

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
legacy_id	query	integer	false	Resource legacy ID
legacy_account_id	query	integer	false	Account id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_bundle_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
legacy_bundle_id	query	integer	false	Bundle id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_account_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
account_id	query	string	false	Account id the subscription is linked to. Required if ‘legacy_id’, ‘legacy_account_id’ or legacy_bundle_id filters are not provided.
mandatory	query	boolean	false	Mandatory subscription filter
status	query	SubscriptionStatusFilterEnum	false	Subscription status filter
type	query	SubscriptionType	false	Subscription type
activation_date	query	DateFilterEnum	false	Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
deactivation_date	query	DateFilterEnum	false	Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
registration_email	query	string	false	Registration email the subscription is linked to.
service_id	query	string	false	Provider service id the subscription is linked to.

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/orange_tv?offset='0'&limit='50'&legacy_id='0'&legacy_account_id='572234234'&legacy_bundle_id='26245435'&account_id='ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'&mandatory='true'&status={"eq":"ACTIVE","in":["ACTIVE"]}&type='NETFLIX'&activation_date='2023-01-05T03:30:15Z'&deactivation_date='2023-01-05T03:30:15Z'&registration_email='peter.sellers@monty.com'&service_id='masmovil003141592' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	OrangeTvSet
403	Forbidden	Forbidden access	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get Orange TV subscription

Get Orange TV subscription by id. Specific type data is included

GET /orgs/{org}/subscriptions/orange_tv/{subscriptionId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/orange_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	OrangeTv
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A subscription with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Update Orange TV subscription

Update specific data of a Orange TV subscription

PATCH /orgs/{org}/subscriptions/orange_tv/{subscriptionId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
body	body	OperationsSet	true	Array of operations to apply to Orange TV specific data

Request body - JsonObject

1
2
3
4
5
6
7
8


[
  {
    "op": "add",
    "path": "/status",
    "value": "DEACTIVATED",
    "reason": "SUBSCRIBER_REQUESTED"
  }
]

Name	Type	Required	Description
anonymous	[Operation]	false	none

Request example

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



curl -X PATCH https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/orange_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "[
  {
    'op': 'add',
    'path': '/status',
    'value': 'DEACTIVATED',
    'reason': 'SUBSCRIBER_REQUESTED'
  }
]" 

Responses

Code	Meaning	Description	Schema
200	OK	OK	OrangeTv
400	Bad Request	Bad request	ErrorResponse
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A subscription with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Endpoints

Subscriptions

Bundles

Promotions

Devices

AddOns

Amazon Prime

Max

Mobile

Broadband

Landline

Orange TV

Orange TV Libre

Disney

Netflix

Credit Limits

Change Requests

Commitments

DeviceInsurance

Multisim

Payment Plans

Operations