API Overview Resources Schemas

Max

Max resource represents a Max streaming subscription containing specific Max data besides all data applicable to any subscription

Add Max subscription to a bundle

Add a new Max subscription to a bundle with the provided data

POST /orgs/{org}/bundles/{id}/subscriptions/max

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization identifier
id	path	string	true	Bundle identifier
body	body	Max	true	Max subscription data

Request body - instance of 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
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


{
  "specific_data": {
    "service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
    "product_id": "beam-max-svod-monthly"
  },
  "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": "CANCELLED",
      "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"
    }
  ],
  "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",
        "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",
        "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"
}

Name	Type	Required	Description
specific_data	MaxSpecificData	false	Max 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



curl -X POST https://subscriptions.masstack.com/v2/orgs/{org}/bundles/{id}/subscriptions/max \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'pre_scoring_id': '1564',
  'catalogue_commercial_product_id': '7125',
  'promotions': [
    {
      'catalogue_promotion_id': '124'
    }
  ],
  'add_ons': [
    {
      'catalogue_add_on_legacy_id': '124',
      'catalogue_add_on_id': '124',
      'deactivation_date': '2025-01-05T03:30:15Z',
      'deactivation_system': 'killflex.auth.masmovil.com'
    }
  ],
  '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	Max subscription successfully added to the bundle	Max
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 Max subscriptions

Returns an array of Max subscriptions in a bundle

GET /orgs/{org}/bundles/{id}/subscriptions/max

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization identifier
id	path	string	true	Bundle identifier

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/{org}/bundles/{id}/subscriptions/max?offset='0'&limit='50' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	MaxSet
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 Max subscriptions

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

GET /orgs/{org}/subscriptions/max

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization name
service_id	query	string	false	Max internal ID for subscription operations
legacy_account_id	query	integer	false	Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated.

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/max?offset='0'&limit='50'&service_id='ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'&legacy_account_id='572234234' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Get Max subscription

Get Max subscription by id. Specific type data is included

GET /orgs/{org}/subscriptions/max/{id}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string	true	Subscription unique identifier

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	OK	Max
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 Max subscription

Update specific data of a Max subscription

PATCH /orgs/{org}/subscriptions/max/{id}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string	true	Subscription unique identifier
body	body	OperationsSet	true	Array of operations to apply to Max 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/max/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	Max
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