masstack

V1
V2
API Overview Resources Schemas

AddOns

Add-ons resource represents a add-ons (value-added service) associated to a subscription

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

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

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

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