masstack

V1
V2
API Overview Resources Schemas

Commitments

Commitments resource represents a customer commitment linked to a promotion or device

Parameters

Name In Type Required Description
org path string true Organization name
id path string(uuid) true Subscription unique identifier
deviceId path string(uuid) true Device unique identifier
commitmentId path string(uuid) true Commitment 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/devices/abcf20cb-35df-4ffe-bca6-c0ed0c28cabc/commitments/ce79b7b0-aa7b-4477-8f21-c4c242b7025f \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Commitment found Commitment
403 Forbidden Forbidden access ErrorResponse
404 Not Found A commitment 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
id path string(uuid) true Subscription unique identifier
promotionId path string(uuid) true Promotion unique identifier
commitmentId path string(uuid) true Commitment unique identifier
body body OperationsSet true Array of operations to apply to the commitment

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/promotions/abcf20cb-35df-4ffe-bca6-c0ed0c28cabc/commitments/ce79b7b0-aa7b-4477-8f21-c4c242b7025f \
  -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 Promotion commitment patched successfully Commitment
400 Bad Request Bad request ErrorResponse
403 Forbidden Forbidden access ErrorResponse
404 Not Found A commitment 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
id path string(uuid) true Subscription unique identifier
deviceId path string(uuid) true Device unique identifier
commitmentId path string(uuid) true Commitment unique identifier
body body OperationsSet true Array of operations to apply to the commitment

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/devices/d45e20cb-35df-4ffe-bca6-c0ed0c28cb39/commitments/ce79b7b0-aa7b-4477-8f21-c4c242b7025f \
  -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 Device commitment patched successfully Commitment
400 Bad Request Bad request ErrorResponse
403 Forbidden Forbidden access ErrorResponse
404 Not Found A commitment 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