AddOns

Get subscription addOns

Get add-ons (value added services) associated to the subscription

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

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
offset	query	integer	false	Pagination offset
limit	query	integer	false	Pagination limit
activation_date	query	DateFilterEnum	false	Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
legacy_add_on_id	query	integer	false	AddOn 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/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons?offset='0'&limit='50'&activation_date='2023-01-05T03:30:15Z'&legacy_add_on_id='572234234' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Add-ons associated to the subscription	AddOnsSet
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

Add an AddOn to a subscription

Add an AddOn to a subscription.

POST /orgs/{org}/subscriptions/{subscriptionId}/add_ons

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
body	body	AddOn	false	Add AddOn to subscription body

Request body - instance of AddOn

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


{
  "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"
}

Name	Type	Required	Description
id	string	true	Add-on unique identifier
legacy_id	integer	false	Legacy add-on id linked to MySim/Apollo storage
catalogue_add_on_legacy_id	string	true	MySim/Apollo related id for the Add-On catalogue resource definition
catalogue_add_on_id	string	true	Catalogue add-on ID
creation_date	string(date-time)	true	add-on creation date. Format according to ISO 8601
creation_system	string	true	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	string(date-time)	true	Date and time when any field of the addOn was last updated. Format according to ISO 8601
status	string	true	add-on status
activation_date	string(date-time)	false	none
deactivation_date	string(date-time)	false	none
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]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'catalogue_add_on_legacy_id': '124',
  'catalogue_add_on_id': '124'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	AddOn added to subscription	AddOn
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 subscription addOn by addOn ID

Get addOn (value added services) associated to the subscription by addon ID

GET /orgs/{org}/subscriptions/{subscriptionId}/add_ons/{addonId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
addonId	path	string(uuid)	true	AddOn 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/add_ons/0100cfa5-06e9-4572-976d-5287916adff1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Deactivate subscription AddOn

Starts the deactivation process of the subscription AddOn.

POST /orgs/{org}/subscriptions/{subscriptionId}/add_ons/{addonId}/deactivate

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
addonId	path	string(uuid)	true	AddOn unique identifier
body	body	SubscriptionAddOnDeactivationRequest	true	Deactivate subscription AddOn data

Request body - instance of SubscriptionAddOnDeactivationRequest

1
2
3


{
  "reason": "SUBSCRIBER_RESIGNATION"
}

Name	Type	Required	Description
reason	string	true	Reason for the deactivation

Property	Values
reason	one of [SUBSCRIBER_RESIGNATION]

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1/deactivate \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'reason': 'SUBSCRIBER_RESIGNATION'
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	Deactivation process started	None
403	Forbidden	Forbidden access	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse