Change Requests

Create new tariff change request for existing subscription

Create a new tariff change request for an existing subscription. The change request will be processed asynchronously

POST /orgs/{org}/subscriptions/{id}/change_requests/tariff

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
body	body	TariffChangeRequest	true	Change request data

Request body - instance of TariffChangeRequest

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


{
  "specific_data": {
    "catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
    "catalogue_promotion_ids": [
      "124",
      "125"
    ]
  },
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "TARIFF",
  "status": "REQUESTED",
  "date_scheduled": "2023-01-01T00:00:00Z",
  "parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "reason": "SUBSCRIBER_REQUESTED",
  "request_user": "asd@asd.com",
  "request_system": "killflex.auth.masmovil.com"
}

Name	Type	Required	Description
specific_data	TariffChangeRequestSpecificData	true	Specific data for the tariff change request

Name	Type	Required	Description
anonymous	ChangeRequest	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



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/tariff \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'specific_data': {
    'catalogue_bundled_commercial_product_id': '8432_BUNDLED_3P',
    'catalogue_promotion_ids': [
      '124',
      '125'
    ]
  },
  'date_scheduled': '2023-01-01T00:00:00Z',
  'reason': 'SUBSCRIBER_REQUESTED'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Tariff change request successfully created	ChangeRequest
403	Forbidden	Forbidden access	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get subscription tariff change requests by properties

get tariff change requests providing certain search criteria

GET /orgs/{org}/subscriptions/{id}/change_requests/tariff

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
status	query	ChangeRequestStatus	false	Change request status filter
date_scheduled	query	DateFilterEnum	false	Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601

Enumerated Values

Property	Values
status	one of [REQUESTED, ON_HOLD, IN_PROGRESS, FINISHED, FAILED, CANCELED]

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/tariff?offset='0'&limit='50'&status='REQUESTED'&date_scheduled='2023-01-05T03:30:15Z' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Create new deactivation change request for existing subscription

Create a new deactivation change request for an existing subscription. The change request will be processed asynchronously

POST /orgs/{org}/subscriptions/{id}/change_requests/deactivation

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
body	body	SubscriptionDeactivationChangeRequest	true	Change request data

Request body - instance of SubscriptionDeactivationChangeRequest

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


{
  "specific_data": {
    "reason": "SUBSCRIBER_RESIGNATION",
    "promotion_commitments_to_cancel": [
      "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
    ],
    "device_commitments_to_cancel": [
      "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
    ]
  },
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "TARIFF",
  "status": "REQUESTED",
  "date_scheduled": "2023-01-01T00:00:00Z",
  "parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "reason": "SUBSCRIBER_REQUESTED",
  "request_user": "asd@asd.com",
  "request_system": "killflex.auth.masmovil.com"
}

Name	Type	Required	Description
specific_data	SubscriptionDeactivationRequest	true	none

Name	Type	Required	Description
anonymous	ChangeRequest	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



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/deactivation \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'specific_data': {
    'reason': 'SUBSCRIBER_RESIGNATION',
    'promotion_commitments_to_cancel': [
      'ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'
    ],
    'device_commitments_to_cancel': [
      'ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'
    ]
  },
  'date_scheduled': '2023-01-01T00:00:00Z',
  'reason': 'SUBSCRIBER_REQUESTED'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Deactivation change request successfully created	SubscriptionDeactivationChangeRequest
403	Forbidden	Forbidden access	ErrorResponse
409	Conflict	A change request for the subscription with the change requested is still in progress	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get subscription deactivation change requests by properties

get deactivation change requests providing certain search criteria

GET /orgs/{org}/subscriptions/{id}/change_requests/deactivation

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
status	query	ChangeRequestStatus	false	Change request status filter
date_scheduled	query	DateFilterEnum	false	Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601

Enumerated Values

Property	Values
status	one of [REQUESTED, ON_HOLD, IN_PROGRESS, FINISHED, FAILED, CANCELED]

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/{org}/subscriptions/{id}/change_requests/deactivation?offset='0'&limit='50'&status='REQUESTED'&date_scheduled='2023-01-05T03:30:15Z' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Create new email change request for existing subscription

Create a new email change request for an existing subscription. The change request will be processed asynchronously

POST /orgs/{org}/subscriptions/{id}/change_requests/email

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
body	body	EmailChangeRequest	true	Change request data

Request body - instance of EmailChangeRequest

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


{
  "specific_data": {
    "registration_email": "newemail@test.com"
  },
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "type": "TARIFF",
  "status": "REQUESTED",
  "date_scheduled": "2023-01-01T00:00:00Z",
  "parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "reason": "SUBSCRIBER_REQUESTED",
  "request_user": "asd@asd.com",
  "request_system": "killflex.auth.masmovil.com"
}

Name	Type	Required	Description
specific_data	EmailChangeRequestSpecificData	true	Specific data for the email change request

Name	Type	Required	Description
anonymous	ChangeRequest	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



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/email \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'specific_data': {
    'registration_email': 'newemail@test.com'
  },
  'date_scheduled': '2023-01-01T00:00:00Z',
  'reason': 'SUBSCRIBER_REQUESTED'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Email change request successfully created	EmailChangeRequest
403	Forbidden	Forbidden access	ErrorResponse
409	Conflict	A change request for the subscription with the change requested is still in progress	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get subscription email change requests by properties

get email change requests providing certain search criteria

GET /orgs/{org}/subscriptions/{id}/change_requests/email

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
status	query	ChangeRequestStatus	false	Change request status filter
date_scheduled	query	DateFilterEnum	false	Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601

Enumerated Values

Property	Values
status	one of [REQUESTED, ON_HOLD, IN_PROGRESS, FINISHED, FAILED, CANCELED]

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/email?offset='0'&limit='50'&status='REQUESTED'&date_scheduled='2023-01-05T03:30:15Z' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Get tariff change request by subscription and changeRequest IDs

Get info for a specific tariff change request

GET /orgs/{org}/subscriptions/{id}/change_requests/tariff/{changeRequestId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
changeRequestId	path	string(uuid)	true	Change request unique identifier

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	Tariff Change request found	TariffChangeRequest
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A change request 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 change requests

Search subscription change requests providing certain search criteria

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

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription’s unique identifier
type	query	ChangeRequestType	false	Change request status filter

Enumerated Values

Property	Values
type	one of [TARIFF, DEACTIVATION, EMAIL]

Request example

1
2
3
4
5



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

Responses

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

Get change request by subscriptionId and changeRequestId

Get info for a specific change request

GET /orgs/{org}/subscriptions/{id}/change_requests/{changeRequestId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription unique identifier
changeRequestId	path	string(uuid)	true	Change request unique identifier

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	Change request found	ChangeRequest
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A change request 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 subscription change request by SubscriptionId and changeRequestId

Update change request

PATCH /orgs/{org}/subscriptions/{id}/change_requests/{changeRequestId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
id	path	string(uuid)	true	Subscription unique identifier
changeRequestId	path	string(uuid)	true	Change request unique identifier
body	body	OperationsSet	false	Array of operations to be applied to the change request fields

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/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/abcf20cb-35df-4ffe-bca6-c0ed0c28cabc \
  -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	ChangeRequest
400	Bad Request	Bad request	ErrorResponse
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A change request with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse