Imported data
bearerAuth Bearer Token (JWT) | Recurso | Descripción |
|---|---|
| AddOns | AddOns resource represents value-added services associated to subscriptions |
| Agile TV | Agile TV resource represents an agile tv subscription containing specific agile tv data besides all data applicable to any subscription |
| Amazon Prime | Amazon Prime resource represents an amazon prime subscription containing specific amazon prime data besides all data applicable to any subscription |
| Broadband | Broadband resource represents a broadband subscription containing specific broadband data besides all data applicable to any subscription |
| Bonuses | Bonuses resource represents bonuses associated to subscriptions |
| Devices | Devices resource represents devices associated to subscriptions |
| Disney | Disney resource represents a Disney subscription containing specific Disney data besides all data applicable to any subscription |
| Max | Max resource represents a Max streaming subscription containing specific Max data besides all data applicable to any subscription |
| Mobile | Mobile resource represents a mobile line subscription containing specific mobile related data besides all data applicable to any subscription |
| Netflix | Netflix resource represents a Netflix subscription containing specific Netflix data besides all data applicable to any subscription |
| Orange TV | Orange TV resource represents a Orange TV subscription containing specific Orange TV data besides all data applicable to any subscription |
| Promotions | Promotions resource represents promotions associated to subscriptions |
| TV | TV resource represents a TV subscription containing specific TV data besides all data applicable to any subscription |
| Bundles | |
| Subscription |
bearerAuth Bearer Token (JWT) | Recurso | Descripción |
|---|---|
| AddOns | AddOns resource represents value-added services associated to subscriptions |
| Agile TV | Agile TV resource represents an agile tv subscription containing specific agile tv data besides all data applicable to any subscription |
| Amazon Prime | Amazon Prime resource represents an amazon prime subscription containing specific amazon prime data besides all data applicable to any subscription |
| Broadband | Broadband resource represents a broadband subscription containing specific broadband data besides all data applicable to any subscription |
| Bonuses | Bonuses resource represents bonuses associated to subscriptions |
| Devices | Devices resource represents devices associated to subscriptions |
| Disney | Disney resource represents a Disney subscription containing specific Disney data besides all data applicable to any subscription |
| Max | Max resource represents a Max streaming subscription containing specific Max data besides all data applicable to any subscription |
| Mobile | Mobile resource represents a mobile line subscription containing specific mobile related data besides all data applicable to any subscription |
| Netflix | Netflix resource represents a Netflix subscription containing specific Netflix data besides all data applicable to any subscription |
| Orange TV | Orange TV resource represents a Orange TV subscription containing specific Orange TV data besides all data applicable to any subscription |
| Promotions | Promotions resource represents promotions associated to subscriptions |
| TV | TV resource represents a TV subscription containing specific TV data besides all data applicable to any subscription |
| Bundles | |
| Subscription |
Get add-ons (value added services) associated to the subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
AddOn id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated.
OK Add-ons associated to the subscription
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons?offset=0&limit=50&activation_date=2023-01-05T03%3A30%3A15Z&legacy_add_on_id=572234234' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a subscription add-on
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
Array of operations to apply to add-on data
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string | Add-on unique identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy add-on id Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_value_added_service_legacy_id
*
| string | MySim/Apollo related id for the Add-On catalogue resource definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_value_added_service_id
*
| string | Catalogue add-on ID | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | add-on creation date. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | 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 | Info about the specific user that requested the addON creation. N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the addOn was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDACTIVECANCELLEDDEACTIVATEDPROVISIONING | Add-on status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | External provider product identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | External provider service identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found AddOn with the specified id was not found
{
"code": "ADD_ON_NOT_FOUND",
"message": "No addOn found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Agile TV subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Agile Tv subscription is linked to.
Provider product ID the Agile Tv subscription is linked to.
Whether the Agile Tv subscription is primary.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/agile_tv?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new Agile TV subscription with the provided data
PATH PARAMETERS
Organization name
Agile TV subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Agile Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Agile Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_primary | boolean | Indicates if the subscription is the primary one for the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Agile TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Agile TV subscription successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Agile Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Agile Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_primary | boolean | Indicates if the subscription is the primary one for the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Agile TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/agile_tv' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}'Get AgileTv subscription by id, including specific type data
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Agile Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Agile Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_primary | boolean | Indicates if the subscription is the primary one for the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Agile TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/agile_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of an AgileTv subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to apply to AgileTv specific data
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"is_primary": true,
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Agile Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Agile Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_primary | boolean | Indicates if the subscription is the primary one for the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Agile TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/agile_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Amazon Prime subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Amazon Prime subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/amazon_prime?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Amazon Prime subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Amazon Prime subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Amazon Prime internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Amazon Prime product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | Amazon Prime internal ID that uniquely identifies the subscription once it has been activated and allows subsequent operations such as info check | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_tier | string | Amazon Prime tier for the subscription according to its internal promotions situation (e.g: free trial),relevant for its B2B billing. Values defined by Amazon | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Amazon Prime subscription successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Amazon Prime internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Amazon Prime product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | Amazon Prime internal ID that uniquely identifies the subscription once it has been activated and allows subsequent operations such as info check | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_tier | string | Amazon Prime tier for the subscription according to its internal promotions situation (e.g: free trial),relevant for its B2B billing. Values defined by Amazon | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/amazon_prime' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}'Get an Amazon Prime subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Amazon Prime internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Amazon Prime product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | Amazon Prime internal ID that uniquely identifies the subscription once it has been activated and allows subsequent operations such as info check | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_tier | string | Amazon Prime tier for the subscription according to its internal promotions situation (e.g: free trial),relevant for its B2B billing. Values defined by Amazon | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/amazon_prime/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to an Amazon Prime subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Amazon Prime subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Amazon Prime internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Amazon Prime product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | Amazon Prime internal ID that uniquely identifies the subscription once it has been activated and allows subsequent operations such as info check | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_tier | string | Amazon Prime tier for the subscription according to its internal promotions situation (e.g: free trial),relevant for its B2B billing. Values defined by Amazon | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/amazon_prime/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Amazon Prime subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Amazon Prime subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "PRIME_1M_BUNDLE",
"provider_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"provider_tier": "prime_1_months_hard_offer"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/amazon_prime?offset=0&limit=50&legacy_id=0&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search Broadband subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Legacy bundle id the subscription is linked to.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Insured device ID
Legacy Id of the insured device in MySim/Apollo storage
Filter by commercial transaction identifier
Legacy service id the Broadband subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"access_id": "J24030AAA925",
"territory_owner": "FIBOR01",
"legacy_service_id": "MYSIM_528310",
"installation_address": {
"street_type": "CALLE",
"address_code": "123142344325235 1215",
"street_name": "CALLE MADRID",
"house_number": "1",
"additional_info": "PLANTA 3, PUERTA 1",
"city": "MADRID",
"province": "MADRID",
"country": "ES",
"post_code": "28155"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/broadband?offset=0&limit=50&legacy_id=0&legacy_bundle_id=572234234&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z&device_id=123e4567-e89b-12d3-a456-426614174000&legacy_device_id=123456&legacy_service_id=MYSIM_528310' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a Broadband subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"access_id": "J24030AAA925",
"territory_owner": "FIBOR01",
"legacy_service_id": "MYSIM_528310",
"installation_address": {
"street_type": "CALLE",
"address_code": "123142344325235 1215",
"street_name": "CALLE MADRID",
"house_number": "1",
"additional_info": "PLANTA 3, PUERTA 1",
"city": "MADRID",
"province": "MADRID",
"country": "ES",
"post_code": "28155"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
access_id | string | Broadband access id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
territory_owner | string | Broadband territory owner | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_service_id | string | Legacy service id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_address | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/broadband/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get info for a specific bonus of subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Bonus unique identifier
OK Bonus found for the subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "36",
"last_updated_date": "2023-01-08T12:00:05Z",
"last_updated_system": "killflex.auth.masmovil.com",
"last_updated_user": "john.doe@masorange.es",
"status": "ACTIVE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id
*
| string | Assigned subscription bonus ID | ||
legacy_id | integer | Assigned legacy subscription bonus ID | ||
catalogue_free_units_package_id
*
| string | Catalogue free units package ID | ||
last_updated_date | string (date-time) | Date and time when any field of the bonus was last updated. Format according to ISO 8601 | ||
last_updated_system | string | Info about the system that last updated the bonus. It contains the mas-stack authentication audience info. N/A if not available | ||
last_updated_user | string | Info about the specific user that last updated the bonus. N/A if not available | ||
status | string
()
REQUESTEDACTIVECANCELLEDDEACTIVATED | |||
activation_date
*
| string (date-time) | Activation date and time of the bonus. Format according to ISO 8601 | ||
deactivation_date | string (date-time) | Deactivation date and time of the bonus. Format according to ISO 8601 | ||
deactivation_system | string | Info about the system that requested the bonus deactivation. It contains the mas-stack authentication audience info when deactivation is requested by mas-stack authenticated user, N/A if not available | ||
deactivation_user | string | Info about the specific user that requested the bonus 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 |
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bonus with the specified id was not found
{
"code": "BONUS_NOT_FOUND",
"message": "No bonus found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/bonuses/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get bonuses associated to the subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
OK Bonuses associated to the subscription
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "36",
"last_updated_date": "2023-01-08T12:00:05Z",
"last_updated_system": "killflex.auth.masmovil.com",
"last_updated_user": "john.doe@masorange.es",
"status": "ACTIVE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/bonuses?offset=0&limit=50' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get info for a specific device of a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
OK Device found for the subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"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,
"catalogue_term_id": "124",
"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"
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) | Device unique identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the device associated with the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_device_id
*
| string | Commercial device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_device_id | string | Device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_shipping_order_id | string | Id of the shipping order related to the device according to logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_pickup_order_id | string | Id of the pickup order related to the device according to reverse logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_delivery_date | string (date-time) | In shop delivery date to the customer. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_returned_date | string (date-time) | In shop returned date. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serial_number | string | The serial number or any alphanumeric identifier of a particular device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mac_address | string | A unique identifier assigned to the device network interface controller | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imei | string | The International Mobile Equipment Identity of the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
acquisition_type | string
()
BORROWEDFINANCEDONE_TIME_PAYMENT | Specifies the type of acquisition for the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commitments | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurable_amount | number | The insurable value of the device, representing the maximum coverage amount for insurance purposes. A null value indicates that the device is not insurable | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
ACTIVECANCELLEDRETURNEDUNKNOWN | Device status derived from Apollo terminal and return data. See https://developers.masstack.com/en/guides/subscriptions/device-status for enum semantics and Device Insurance validation behavior. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Promotions associated to the device according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A device with the specified id was not found
{
"code": "DEVICE_NOT_FOUND",
"message": "No device found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to a device
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Device patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"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,
"catalogue_term_id": "124",
"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"
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) | Device unique identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the device associated with the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_device_id
*
| string | Commercial device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_device_id | string | Device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_shipping_order_id | string | Id of the shipping order related to the device according to logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_pickup_order_id | string | Id of the pickup order related to the device according to reverse logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_delivery_date | string (date-time) | In shop delivery date to the customer. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_returned_date | string (date-time) | In shop returned date. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serial_number | string | The serial number or any alphanumeric identifier of a particular device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mac_address | string | A unique identifier assigned to the device network interface controller | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imei | string | The International Mobile Equipment Identity of the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
acquisition_type | string
()
BORROWEDFINANCEDONE_TIME_PAYMENT | Specifies the type of acquisition for the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commitments | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurable_amount | number | The insurable value of the device, representing the maximum coverage amount for insurance purposes. A null value indicates that the device is not insurable | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
ACTIVECANCELLEDRETURNEDUNKNOWN | Device status derived from Apollo terminal and return data. See https://developers.masstack.com/en/guides/subscriptions/device-status for enum semantics and Device Insurance validation behavior. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Promotions associated to the device according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A device with the specified id was not found
{
"code": "DEVICE_NOT_FOUND",
"message": "No device found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Accept a device swap request for a subscription device
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
{
"new_serial_number": "ABC123456789",
"transfer_with": "fd2fcd90-2218-4ef1-917b-7ce5f35eee1c"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
new_serial_number | string | New device serial number for automatic swaps | ||
transfer_with | string (uuid) | Device identifier to transfer with |
Accepted Device swap request accepted
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A device with the specified id was not found
{
"code": "DEVICE_NOT_FOUND",
"message": "No device found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/swap' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"new_serial_number": "ABC123456789",
"transfer_with": "fd2fcd90-2218-4ef1-917b-7ce5f35eee1c"
}'Get all subscription devices associated to the subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Mac address filter
Serial number filter
OK Devices found for the subscription
[
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"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,
"catalogue_term_id": "124",
"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"
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) | Device unique identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the device associated with the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_device_id
*
| string | Commercial device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_device_id | string | Device id according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_shipping_order_id | string | Id of the shipping order related to the device according to logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_pickup_order_id | string | Id of the pickup order related to the device according to reverse logistics | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_delivery_date | string (date-time) | In shop delivery date to the customer. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_store_returned_date | string (date-time) | In shop returned date. Format according to ISO 8601. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serial_number | string | The serial number or any alphanumeric identifier of a particular device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mac_address | string | A unique identifier assigned to the device network interface controller | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imei | string | The International Mobile Equipment Identity of the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
acquisition_type | string
()
BORROWEDFINANCEDONE_TIME_PAYMENT | Specifies the type of acquisition for the device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commitments | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurable_amount | number | The insurable value of the device, representing the maximum coverage amount for insurance purposes. A null value indicates that the device is not insurable | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
ACTIVECANCELLEDRETURNEDUNKNOWN | Device status derived from Apollo terminal and return data. See https://developers.masstack.com/en/guides/subscriptions/device-status for enum semantics and Device Insurance validation behavior. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Promotions associated to the device according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices?mac_address=00-B0-D0-63-C2-26&serial_number=SN-48392A7F4B' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search Disney subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider user ID the Disney subscription is linked to.
Provider service ID the Disney subscription is linked to.
Provider product ID the Disney subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/disney?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Disney subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Disney subscription data.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_user_id | string | The provider user identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Disney subscription successfully added.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_user_id | string | The provider user identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/disney' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}'Get a Disney subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_user_id | string | The provider user identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/disney/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to a Disney subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Disney subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_user_id | string | The provider user identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/disney/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Disney subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider user ID the Disney subscription is linked to.
Provider service ID the Disney subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "com.disney.yoigo.es.bundle.standard"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/disney?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search Max subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Max subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/max?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Max subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Max subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Max internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Max product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Max subscription successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Max internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Max product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/max' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}'Get a Max subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Max internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Max product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/max/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to a Max subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Max subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Max internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Max product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/max/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Max subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Max subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "beam-max-svod-monthly"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/max?offset=0&limit=50&legacy_id=0&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search mobile subscriptions matching certain criteria. Specific type data is included.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. Required if the legacy_id or account_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Insured device ID
Legacy Id of the insured device in MySim/Apollo storage
Filter by commercial transaction identifier
MSISDN (Mobile Station International Subscriber Directory Number) following E.164 format. Spanish country code is assumed if plus sign(+) is not included to indicate international format.
IMSI (International Mobile Subscriber Identity)
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"msisdn": 34611223344,
"sim": {
"iccid": "8934000000000000002",
"imsi": "214040000000000",
"type": "SIM"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/mobile?offset=0&limit=50&legacy_id=0&legacy_bundle_id=26245435&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z&device_id=123e4567-e89b-12d3-a456-426614174000&legacy_device_id=123456&msisdn=34611223344&imsi=214040000000000' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a mobile subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"msisdn": 34611223344,
"sim": {
"iccid": "8934000000000000002",
"imsi": "214040000000000",
"type": "SIM"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn | string | MSISDN (Mobile Station International Subscriber Directory Number) formatted following E.164 format | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sim | object | SIM card information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/mobile/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search Netflix subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Netflix subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/netflix?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Netflix subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Netflix subscription data.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | The provider bundle identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Netflix subscription successfully added.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | The provider bundle identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/netflix' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}'Get a Netflix subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | The provider bundle identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/netflix/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to a Netflix subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Netflix subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | The provider service identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_bundle_id | string | The provider bundle identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | The provider product identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/netflix/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Netflix subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Provider service ID the Netflix subscription is linked to.
Registration email the Netflix subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"provider_service_id": "7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"provider_bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"provider_product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/netflix?offset=0&limit=50&legacy_id=0&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search Orange TV subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Registration email the subscription is linked to.
Provider service id the subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/orange_tv?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z®istration_email=peter.sellers%40monty.com&provider_service_id=masmovil003141592' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Orange TV subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Orange TV subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_email
*
| string | Email address linked to the Orange TV subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Orange Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Orange Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Orange TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Orange TV subscription successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_email
*
| string | Email address linked to the Orange TV subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Orange Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Orange Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Orange TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/orange_tv' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}'Get an Orange TV subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_email
*
| string | Email address linked to the Orange TV subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Orange Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Orange Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Orange TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/orange_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to an Orange TV subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Orange TV subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_email
*
| string | Email address linked to the Orange TV subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_service_id | string | Orange Tv internal ID that identifies the subscription for any required operation to be performed on it, e.g: activate, update, cancel, etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_product_id | string | Orange Tv product ID according to its provided catalog definition, relevant for B2B billing. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires_installation
*
| boolean | Indicates if the Orange TV STB must be send via installations (true) or logistics (false) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/orange_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Search Orange TV subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Filter by commercial transaction identifier
Registration email the Orange TV subscription is linked to.
Provider service ID the Orange TV subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"provider_service_id": "yoigo123456789",
"provider_product_id": "SP_OFFER_0200000",
"requires_installation": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/orange_tv?offset=0&limit=50&legacy_id=0&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get info for a specific promotion of subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
OK Promotion found for the subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string | Promotion ID | ||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy promotion ID | ||||||||||||||||||||||||||||||||||||||||||
catalogue_promotion_id
*
| string | Catalogue promotion ID | ||||||||||||||||||||||||||||||||||||||||||
commitments | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Promotion creation date. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system that requested the promotion creation. It contains the mas-stack authentication audience info. N/A if not available | ||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the promotion creation. N/A if not available | ||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the promotion was last updated. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDACTIVECANCELLEDDEACTIVATEDEXPIRED | |||||||||||||||||||||||||||||||||||||||||||
status_detail | string
()
AUTOMATICALLY_ADDEDAUTOMATICALLY_REMOVEDBUNDLE_SALEMANUALLY_ADDEDMANUALLY_REMOVEDOTHERPROMOTION_INCOMPATIBILITYSUBSCRIPTION_ADDED_TO_BUNDLESUBSCRIPTION_DEACTIVATION | Detail for the promotion current status | ||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time the promotion is or will be available in the subscription. When provided, it is restricted to be between current billing cycle and less than a year from now. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
expiration_date | string (date-time) | The date and time when the promotion expires. Format according to ISO 8601. | ||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, promotion is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system that requested the promotion deactivation. It contains the mas-stack authentication audience info when deactivation is requested by mas-stack authenticated user, N/A for legacy systems created promotions | ||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the promotion 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 | ||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A promotion with the specified id was not found
{
"code": "PROMOTION_NOT_FOUND",
"message": "No promotion found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get promotions associated to the subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource expiration date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Promotion status filter
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Catalogue promotion identifier
OK Promotions associated to the subscription
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions?offset=0&limit=50&activation_date=2023-01-05T03%3A30%3A15Z&expiration_date=2023-01-05T03%3A30%3A15Z&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&catalogue_promotion_id=124' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new promotion to an existing subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
HEADER PARAMETERS
Promotion input data
{
"catalogue_promotion_id": "1572",
"origin": "EXISTING_CLIENT"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
catalogue_promotion_id
*
| string | Catalogue promotion ID | ||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Origin used to validate the promotion in catalogue | ||
activation_date | string (date-time) | Promotion activation date. Format according to ISO 8601 |
Created Promotion successfully added to the subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string | Promotion ID | ||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy promotion ID | ||||||||||||||||||||||||||||||||||||||||||
catalogue_promotion_id
*
| string | Catalogue promotion ID | ||||||||||||||||||||||||||||||||||||||||||
commitments | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Promotion creation date. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system that requested the promotion creation. It contains the mas-stack authentication audience info. N/A if not available | ||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the promotion creation. N/A if not available | ||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the promotion was last updated. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDACTIVECANCELLEDDEACTIVATEDEXPIRED | |||||||||||||||||||||||||||||||||||||||||||
status_detail | string
()
AUTOMATICALLY_ADDEDAUTOMATICALLY_REMOVEDBUNDLE_SALEMANUALLY_ADDEDMANUALLY_REMOVEDOTHERPROMOTION_INCOMPATIBILITYSUBSCRIPTION_ADDED_TO_BUNDLESUBSCRIPTION_DEACTIVATION | Detail for the promotion current status | ||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time the promotion is or will be available in the subscription. When provided, it is restricted to be between current billing cycle and less than a year from now. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
expiration_date | string (date-time) | The date and time when the promotion expires. Format according to ISO 8601. | ||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, promotion is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | ||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system that requested the promotion deactivation. It contains the mas-stack authentication audience info when deactivation is requested by mas-stack authenticated user, N/A for legacy systems created promotions | ||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the promotion 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 | ||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Conflict Promotion already exists in the subscription
{
"code": "PROMOTION_ALREADY_EXISTS",
"message": "Promotion 1572 already exists",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-auth-origin-sub: string' \
-H 'x-auth-origin-aud: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"catalogue_promotion_id": "1572",
"origin": "EXISTING_CLIENT"
}'Get all promotions associated with an add-on
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource expiration date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Promotion status filter
OK Promotions found for the add-on
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found AddOn with the specified id was not found
{
"code": "ADD_ON_NOT_FOUND",
"message": "No addOn found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1/promotions?offset=0&limit=50&activation_date=2023-01-05T03%3A30%3A15Z&expiration_date=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search TV subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. Required if the legacy_id or account_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Insured device ID
Legacy Id of the insured device in MySim/Apollo storage
Filter by commercial transaction identifier
Legacy service id the TV subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"registration_phone": "600123123"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/tv?offset=0&limit=50&legacy_id=0&legacy_bundle_id=26245435&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z&device_id=123e4567-e89b-12d3-a456-426614174000&legacy_device_id=123456&legacy_service_id=MYSIM_528310' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a TV subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
{
"id": null,
"legacy_id": null,
"catalogue_term_id": null,
"expiration_date": null,
"cancellation_date": null,
"cancellation_system": null,
"cancellation_user": null
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"registration_email": "john.doe@mail.com",
"registration_phone": "600123123"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_email | string (email) | Email address linked to the TV subscription. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registration_phone | string | Registration phone linked to the TV subscription. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search subscription bundles providing certain search criteria
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Account id the subscription is linked to.
Resource legacy ID
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"catalogue_bundled_product_id": 8432,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"dealer_id": "245655",
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 5345,
"status": "ACTIVE",
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masmovil.com",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles?offset=0&limit=50&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&legacy_id=0' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get subscription bundle basic info
PATH PARAMETERS
Organization name
Bundle identifier
OK OK
{
"catalogue_bundled_product_id": 8432,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"dealer_id": "245655",
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 5345,
"status": "ACTIVE",
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masmovil.com",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
catalogue_bundled_product_id
*
| string | Bundled product id according to catalogue definition | ||
account_id | string (uuid) | Unique identifier of the account | ||
dealer_id | string | Dealer id. Required if 'external_sell_id' is not provided. | ||
id
*
| string | Unique identifier of the subscriptions bundle | ||
legacy_id | integer | Legacy unique identifier of the subscriptions bundle | ||
status | string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Bundle status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | ||
last_status_update | string (date-time) | Last status update date and time. Format according to ISO 8601 | ||
last_status_reason | string | Reason for the last status update according to defined values. Check possible values in status table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | ||
creation_date | string (date-time) | Subscription creation date and time. Format according to ISO 8601 | ||
creation_system
*
| string | Info about the system that requested the bundle creation. It contains the mas-stack authentication audience info | ||
creation_user
*
| string | Info about the specific user that requested the bundle creation | ||
activation_date | string (date-time) | Activation date and time, bundle is considered chargeable and available for the user from this time on. Format according to ISO 8601 | ||
deactivation_date | string (date-time) | Deactivation date and time, bundle is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 |
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search subscriptions matching given criteria, at least one of the query params is required.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Bundle id the subscription is linked to. to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Insured device ID
Legacy Id of the insured device in MySim/Apollo storage
Filter by commercial transaction identifier
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions?offset=0&limit=50&legacy_id=0&bundle_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z&device_id=123e4567-e89b-12d3-a456-426614174000&legacy_device_id=123456' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search subscriptions within a specific bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to.
Mandatory subscription filter
Subscription status filter
Subscription type
Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Insured device ID
Legacy Id of the insured device in MySim/Apollo storage
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
{
"id": null,
"legacy_id": null,
"catalogue_promotion_id": null,
"commitments": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"status_detail": null,
"activation_date": null,
"expiration_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_value_added_service_legacy_id": null,
"catalogue_value_added_service_id": null,
"promotions": null,
"creation_date": null,
"creation_system": null,
"creation_user": null,
"last_updated_date": null,
"status": null,
"activation_date": null,
"deactivation_date": null,
"deactivation_system": null,
"deactivation_user": null,
"provider_product_id": null,
"provider_service_id": null
}
],
"free_units_packages": [
{
"id": null,
"legacy_id": null,
"catalogue_free_units_package_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices": [
{
"id": null,
"legacy_id": null,
"catalogue_commercial_device_id": null,
"catalogue_device_id": null,
"logistics_shipping_order_id": null,
"logistics_pickup_order_id": null,
"in_store_delivery_date": null,
"in_store_returned_date": null,
"serial_number": null,
"mac_address": null,
"imei": null,
"acquisition_type": null,
"commitments": null,
"insurable_amount": null,
"status": null,
"account_id": null,
"promotions": null
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": null,
"legacy_bundle_id": null,
"start_date": null,
"end_date": null
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
limit
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
*
| integer | Limit of items per response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total
*
| integer | Total number of results for search criteria | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A bundle with the specified id was not found
{
"code": "BUNDLE_NOT_FOUND",
"message": "No bundle found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions?offset=0&limit=50&legacy_id=0&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&mandatory=true&activation_date=2023-01-05T03%3A30%3A15Z&deactivation_date=2023-01-05T03%3A30%3A15Z&device_id=123e4567-e89b-12d3-a456-426614174000&legacy_device_id=123456' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a subscription by its unique identifier
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
null
],
"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": null,
"status_detail": null,
"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"
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"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,
"catalogue_term_id": "124",
"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"
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
null
],
"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": null,
"status_detail": null,
"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"
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X GET 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Apply patch operations to a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
op
*
| string
()
replace | Operation to be performed on the entity | ||
path
*
| string | Path to the field to be updated | ||
value
*
| any | Value to use for the operation |
OK Subscription patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"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,
"catalogue_term_id": "124",
"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": "ACTIVE",
"status_detail": "SUBSCRIPTION_DEACTIVATION",
"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_value_added_service_legacy_id": "124",
"catalogue_value_added_service_id": "124",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
null
],
"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": null,
"status_detail": null,
"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"
}
],
"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",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}
],
"free_units_packages": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_free_units_package_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-15T10:30:00Z"
}
],
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"logistics_shipping_order_id": "18395",
"logistics_pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"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,
"catalogue_term_id": "124",
"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"
}
],
"insurable_amount": 135.49,
"status": "ACTIVE",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"promotions": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
null
],
"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": null,
"status_detail": null,
"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"
}
]
}
],
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "SUBSCRIPTION_ADDED_TO_BUNDLE",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"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",
"bundles_history": [
{
"bundle_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_bundle_id": 54,
"start_date": "2022-12-01T00:00:00Z",
"end_date": "2023-01-05T03:30:15Z"
}
],
"commercial_transaction_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
*
| string (uuid) | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
*
| string | Subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_commercial_product_id | string | Commercial product id according to catalogue definition regardless of the bundle the subscription is included in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
*
| string
()
REQUESTEDON_HOLDPROVISIONINGACTIVEDEACTIVATINGDEACTIVATEDCANCELLINGCANCELLED | Subscription status, check https://developers.masstack.com/en/guides/subscriptions/lifecycle for more information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | Ids of applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of applicable add-ons(value added services) according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | Ids of free units packages according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
devices | object[] | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_update
*
| string (date-time) | Last status update date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_status_reason
*
| string | Reason for the last status update according to defined values. Check possible values in STATUS/STATUS table in https://developers.masstack.com/en/guides/subscriptions/lifecycle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | Activation date and time, subscription is considered chargeable and available for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_date | string (date-time) | Deactivation date and time, subscription is considered cancelled or inactive for the user from this time on. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id
*
| string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle_related_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
*
| string (date-time) | Subscription creation date and time. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_system
*
| string | Info about the system/frontend originating the subscription creation. It contains the mas-stack authentication audience info for mas-stack authenticated subscription creation or N/A for others | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_user
*
| string | Info about the specific user that requested the subscription creation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription creation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_updated_date
*
| string (date-time) | Date and time when any field of the subscription was last updated. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_system | string | Info about the system/frontend originating the subscription deactivation. It contains the mas-stack authentication audience info for mas-stack authenticated deactivation or other user info for legacy systems if available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_user | string | Info about the specific user that requested the subscription deactivation. It contains the mas-stack authentication subject info for mas-stack authenticated subscription deactivation, other user info for subscriptions created by legacy systems if available or N/A if not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundles_history | object[] | History of bundles the subscription has been part of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_transaction_id
*
| string | Unique identifier of the last associated commercial transaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X PATCH 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "logistics_shipping_order_id",
"value": "new-shipping-order-id"
}
]'Cancel an active subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Cancellation request
{
"reason": "SUBSCRIBER_RESIGNATION"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason
*
| string
()
ACCOUNT_MIGRATIONBUNDLE_CANCELLATIONBUNDLE_DEACTIVATIONBUNDLE_MIGRATIONFRAUD_CHECK_REJECTIONEXPEDITION_CANCELLEDOTHERPAYMENT_ERRORPROVISIONING_ISSUESUBSCRIBER_RESIGNATIONAUTOMATICALLY_REMOVED | Reason for the cancellation request |
Accepted Cancellation process started
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Conflict Subscription was modified by another process. Concurrent modification detected.
{
"code": "CONFLICT",
"message": "Subscription was modified by another process. Please retry.",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/cancel' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "SUBSCRIBER_RESIGNATION"
}'Starts the deactivation process of the subscription.
PATH PARAMETERS
Organization name
Subscription unique identifier
Deactivate subscription data
{
"reason": "SUBSCRIBER_RESIGNATION",
"promotion_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
],
"device_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
],
"add_on_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason
*
| string
()
ACCOUNT_MIGRATIONBUNDLE_CANCELLATIONBUNDLE_DEACTIVATIONBUNDLE_MIGRATIONFRAUD_CHECK_REJECTIONNON_PAYMENTOTHERPAYMENT_ERRORPROVISIONING_ISSUESUBSCRIBER_RESIGNATIONDEACTIVATED_ON_THIRD_PARTYAUTOMATICALLY_REMOVED | Reason for the deactivation | ||
promotion_commitments_to_cancel | string (uuid)[] | Promotion commitment IDs to cancel in the deactivation process | ||
device_commitments_to_cancel | string (uuid)[] | Device commitment IDs to cancel in the deactivation process | ||
add_on_commitments_to_cancel | string (uuid)[] | Add-on commitment IDs to cancel in the deactivation process |
Accepted Deactivation process started
Bad Request Bad request
{
"code": "INVALID_REQUEST",
"message": "The request is invalid",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Forbidden Forbidden access
{
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Not Found A subscription with the specified id was not found
{
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "No subscription found with given id",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Conflict Subscription was modified by another process. Concurrent modification detected.
{
"code": "CONFLICT",
"message": "Subscription was modified by another process. Please retry.",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Internal Server Error Internal server error
{
"code": "DATABASE_ACCESS_ERROR",
"message": "The database is not accessible",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Any client or server error
{
"code": "ERROR_CODE",
"message": "Error message",
"reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
*
| object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
curl -X POST 'https://subscriptions.masstack.com/v3/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/deactivate' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "SUBSCRIBER_RESIGNATION",
"promotion_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
],
"device_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
],
"add_on_commitments_to_cancel": [
"ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
]
}'