Imported data
bearerAuth Bearer Token (JWT) | Resource | Description |
|---|---|
| Subscriptions | Subscription resource contains all the data applicable to any kind of subscription regardless its type |
| Bundles | Bundle resource represents a bundle containing multiple subscriptions according to certain commercial definition |
| Promotions | Promotion resource represents a promotion associated to a subscription |
| Devices | Device resource represents a device associated to a subscription |
| AddOns | Add-ons resource represents a add-ons (value-added service) associated to a subscription |
| Amazon Prime | Amazon Prime resource represents an amazon prime subscription containing specific amazon prime 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 |
| Broadband | Broadband resource represents a broadband connection subscription containing specific broadband connection data besides all data applicable to any subscription |
| Landline | Landline resource represents a landline subscription containing specific landline 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 |
| Orange TV Libre | Orange Tv Libre resource represents a Orange Tv Libre subscription containing specific Orange Tv Libre data besides all data applicable to any subscription |
| Disney | Disney resource represents a Disney subscription containing specific Disney data besides all data applicable to any subscription |
| AgileTv | AgileTv resource represents an AgileTv subscription containing specific AgileTv 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 |
| Credit Limits | Credit limits resource represents credit limits associated to a subscription or a tenant |
| Change Requests | Change requests resource represents a change request over a bundle or subscription |
| Commitments | Commitments resource represents a customer commitment linked to a promotion or device |
| DeviceInsurance | DeviceInsurance resource represents a Device Insurance subscription containing specific Device Insurance data besides all data applicable to any subscription |
| Multisim | Multisim resource represents a multisim subscription containing specific multisim related data besides all data applicable to any subscription |
| Payment Plans | Payment Plans resource represents a payment plan associated to a device that is associated to a subscription |
| Operations | Subscription administration operations |
| Contracts | Contract documents associated with subscriptions or bundles |
bearerAuth Bearer Token (JWT) | Resource | Description |
|---|---|
| Subscriptions | Subscription resource contains all the data applicable to any kind of subscription regardless its type |
| Bundles | Bundle resource represents a bundle containing multiple subscriptions according to certain commercial definition |
| Promotions | Promotion resource represents a promotion associated to a subscription |
| Devices | Device resource represents a device associated to a subscription |
| AddOns | Add-ons resource represents a add-ons (value-added service) associated to a subscription |
| Amazon Prime | Amazon Prime resource represents an amazon prime subscription containing specific amazon prime 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 |
| Broadband | Broadband resource represents a broadband connection subscription containing specific broadband connection data besides all data applicable to any subscription |
| Landline | Landline resource represents a landline subscription containing specific landline 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 |
| Orange TV Libre | Orange Tv Libre resource represents a Orange Tv Libre subscription containing specific Orange Tv Libre data besides all data applicable to any subscription |
| Disney | Disney resource represents a Disney subscription containing specific Disney data besides all data applicable to any subscription |
| AgileTv | AgileTv resource represents an AgileTv subscription containing specific AgileTv 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 |
| Credit Limits | Credit limits resource represents credit limits associated to a subscription or a tenant |
| Change Requests | Change requests resource represents a change request over a bundle or subscription |
| Commitments | Commitments resource represents a customer commitment linked to a promotion or device |
| DeviceInsurance | DeviceInsurance resource represents a Device Insurance subscription containing specific Device Insurance data besides all data applicable to any subscription |
| Multisim | Multisim resource represents a multisim subscription containing specific multisim related data besides all data applicable to any subscription |
| Payment Plans | Payment Plans resource represents a payment plan associated to a device that is associated to a subscription |
| Operations | Subscription administration operations |
| Contracts | Contract documents associated with subscriptions or bundles |
Get subscriptions belonging to a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
]
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search subscriptions matching specific properties
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
]
}
]
}| 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/v2/orgs/yoigo/subscriptions?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get subscriptions details by subscription ID
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update variable fields of subscriptions, applicable to subscription generic data that is not specific for a given type
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to be applied to the subscription generic data fields
[
{
"op": "deactivate",
"reason": "SUBSCRIBER_RESIGNATION"
}
][
{
"op": "cancel",
"reason": "SUBSCRIBER_RESIGNATION"
}
][
{
"op": "migrate",
"path": "bundle_related_info",
"value": "1233-35df-4ffe-bca6-c0ed0c28cb39"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 PATCH 'https://subscriptions.masstack.com/v2/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": "deactivate",
"reason": "SUBSCRIBER_RESIGNATION"
}
]'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/v2/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/v2/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"
]
}'Activate a subscription. This endpoint will only consider the activation date if it is a prepaid subscription.
PATH PARAMETERS
Organization name
Subscription unique identifier
Activation request
{
"activation_date": "2023-01-01T00:00:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
activation_date | string (date-time) | Date and time when the subscription is activated. Format according to ISO 8601 |
Accepted Activation 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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/activate' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"activation_date": "2023-01-01T00:00:00Z"
}'Search subscriptions matching specific properties
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Changes matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
Subscription status filter
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
]
}
]
}| 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/history?offset=0&limit=50&last_updated_date=2023-01-05T03%3A30%3A15Z' \
-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. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
Resource legacy ID
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
null
],
"broadband": [
null
],
"landline": [
null
],
"amazon_prime": [
null
],
"tv": [
null
],
"netflix": [
null
],
"max": [
null
],
"orange_tv": [
null
],
"orange_tv_libre": [
null
],
"disney": [
null
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"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/v2/orgs/yoigo/bundles?offset=0&limit=50&legacy_account_id=572234234&account_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39&legacy_id=0' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new bundle with the provided data
PATH PARAMETERS
Organization name
Bundle data
{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"msisdn": null,
"mobile_portability_info": null,
"sim": null
}
}
],
"broadband": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"access_id": null,
"vacant_loop": null,
"territory_owner": null,
"access_reuse_info_allowed": null,
"legacy_service_id": null,
"installation_address": null
}
}
],
"landline": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"fixed_phone_number": null,
"installation_address": null,
"contact_info": null,
"fixed_portability_info": null
}
}
],
"amazon_prime": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"entitlement_id": null,
"product_id": null,
"prime_bundle_id": null,
"bundle_tier": null
}
}
],
"tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"registration_email": null,
"technical_installation_required": null,
"contact_number": null,
"id_doc": null
}
}
],
"netflix": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"bundle_id": null,
"product_id": null
}
}
],
"max": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"product_id": null
}
}
],
"orange_tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null
}
}
],
"orange_tv_libre": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null,
"password": null
}
}
],
"disney": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"user_id": null,
"service_id": null,
"product_id": null
}
}
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Required if 'legacy_id' filter is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_customer_id | integer | Customer id the account id is linked to. Required if 'external_sell_id' is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dealer_id | string | Dealer id. Required if 'external_sell_id' is not provided. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financial_evaluation_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_sell_id | string | Legacy field to relate bundle to external sale operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchase_payment | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriptions | object | Set of subscriptions to include on bundle grouped by type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fraud_check_status | string
()
APPROVEDDENIEDUNDER_REVIEWDOCUMENTATION_REQUIRED | Current fraud check status for the bundle creation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_order_id | string | Id of the installation order related to the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_id | string | Id of the contract generated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_delivery_channel | string
()
APPLICATIONPAPEREMAILUNKNOWN | Delivery channel used to send the contract | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin | string
()
NEW_SALECROSS_SELLMIGRATIONADD_SUBSCRIPTIONUNKNOWN | Bundle process origin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
app_id | integer | Application id according to MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Bundle successfully created
{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"msisdn": null,
"mobile_portability_info": null,
"sim": null
}
}
],
"broadband": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"access_id": null,
"vacant_loop": null,
"territory_owner": null,
"access_reuse_info_allowed": null,
"legacy_service_id": null,
"installation_address": null
}
}
],
"landline": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"fixed_phone_number": null,
"installation_address": null,
"contact_info": null,
"fixed_portability_info": null
}
}
],
"amazon_prime": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"entitlement_id": null,
"product_id": null,
"prime_bundle_id": null,
"bundle_tier": null
}
}
],
"tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"registration_email": null,
"technical_installation_required": null,
"contact_number": null,
"id_doc": null
}
}
],
"netflix": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"bundle_id": null,
"product_id": null
}
}
],
"max": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"product_id": null
}
}
],
"orange_tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null
}
}
],
"orange_tv_libre": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null,
"password": null
}
}
],
"disney": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"user_id": null,
"service_id": null,
"product_id": null
}
}
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Required if 'legacy_id' filter is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_customer_id | integer | Customer id the account id is linked to. Required if 'external_sell_id' is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dealer_id | string | Dealer id. Required if 'external_sell_id' is not provided. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financial_evaluation_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_sell_id | string | Legacy field to relate bundle to external sale operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchase_payment | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriptions | object | Set of subscriptions to include on bundle grouped by type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fraud_check_status | string
()
APPROVEDDENIEDUNDER_REVIEWDOCUMENTATION_REQUIRED | Current fraud check status for the bundle creation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_order_id | string | Id of the installation order related to the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_id | string | Id of the contract generated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_delivery_channel | string
()
APPLICATIONPAPEREMAILUNKNOWN | Delivery channel used to send the contract | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin | string
()
NEW_SALECROSS_SELLMIGRATIONADD_SUBSCRIPTIONUNKNOWN | Bundle process origin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
app_id | integer | Application id according to MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"msisdn": null,
"mobile_portability_info": null,
"sim": null
}
}
],
"broadband": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"access_id": null,
"vacant_loop": null,
"territory_owner": null,
"access_reuse_info_allowed": null,
"legacy_service_id": null,
"installation_address": null
}
}
],
"landline": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"fixed_phone_number": null,
"installation_address": null,
"contact_info": null,
"fixed_portability_info": null
}
}
],
"amazon_prime": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"entitlement_id": null,
"product_id": null,
"prime_bundle_id": null,
"bundle_tier": null
}
}
],
"tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"registration_email": null,
"technical_installation_required": null,
"contact_number": null,
"id_doc": null
}
}
],
"netflix": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"bundle_id": null,
"product_id": null
}
}
],
"max": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"product_id": null
}
}
],
"orange_tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null
}
}
],
"orange_tv_libre": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null,
"password": null
}
}
],
"disney": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"user_id": null,
"service_id": null,
"product_id": null
}
}
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}'Get subscription bundle basic info
PATH PARAMETERS
Organization name
Bundle identifier
OK OK
{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"msisdn": null,
"mobile_portability_info": null,
"sim": null
}
}
],
"broadband": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"access_id": null,
"vacant_loop": null,
"territory_owner": null,
"access_reuse_info_allowed": null,
"legacy_service_id": null,
"installation_address": null
}
}
],
"landline": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"fixed_phone_number": null,
"installation_address": null,
"contact_info": null,
"fixed_portability_info": null
}
}
],
"amazon_prime": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"entitlement_id": null,
"product_id": null,
"prime_bundle_id": null,
"bundle_tier": null
}
}
],
"tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"registration_email": null,
"technical_installation_required": null,
"contact_number": null,
"id_doc": null
}
}
],
"netflix": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"bundle_id": null,
"product_id": null
}
}
],
"max": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"product_id": null
}
}
],
"orange_tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null
}
}
],
"orange_tv_libre": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null,
"password": null
}
}
],
"disney": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"user_id": null,
"service_id": null,
"product_id": null
}
}
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Required if 'legacy_id' filter is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_customer_id | integer | Customer id the account id is linked to. Required if 'external_sell_id' is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dealer_id | string | Dealer id. Required if 'external_sell_id' is not provided. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financial_evaluation_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_sell_id | string | Legacy field to relate bundle to external sale operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchase_payment | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriptions | object | Set of subscriptions to include on bundle grouped by type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fraud_check_status | string
()
APPROVEDDENIEDUNDER_REVIEWDOCUMENTATION_REQUIRED | Current fraud check status for the bundle creation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_order_id | string | Id of the installation order related to the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_id | string | Id of the contract generated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_delivery_channel | string
()
APPLICATIONPAPEREMAILUNKNOWN | Delivery channel used to send the contract | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin | string
()
NEW_SALECROSS_SELLMIGRATIONADD_SUBSCRIPTIONUNKNOWN | Bundle process origin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
app_id | integer | Application id according to MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update variable fields of bundles
PATH PARAMETERS
Organization name
Bundle identifier
Array of operations to be applied to the bundle
[
{
"op": "replace",
"path": "status",
"value": "ACTIVE"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"catalogue_bundled_product_id": 8432,
"legacy_account_id": "245655",
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_customer_id": "245655",
"dealer_id": "245655",
"financial_evaluation_info": {
"credit_limit": 1000,
"credit_limit_available": 1000,
"pre_scoring_id": 18395,
"score_value": 71,
"upfront": 0
},
"signature_process_id": 18395,
"external_sell_id": 242940268,
"purchase_payment": {
"total_amount": 149,
"tax_amount": 10,
"first_invoice_payment": 5,
"point_of_sale_payment": 33,
"platform": "ADYEN",
"transaction_id": "PLC6640C65E45847BC",
"link": "https://test.adyen.link/PLC6640C65E45847BC",
"external_reference": "2311BDXI1880"
},
"subscriptions": {
"mobile": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"msisdn": null,
"mobile_portability_info": null,
"sim": null
}
}
],
"broadband": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"access_id": null,
"vacant_loop": null,
"territory_owner": null,
"access_reuse_info_allowed": null,
"legacy_service_id": null,
"installation_address": null
}
}
],
"landline": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"fixed_phone_number": null,
"installation_address": null,
"contact_info": null,
"fixed_portability_info": null
}
}
],
"amazon_prime": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"entitlement_id": null,
"product_id": null,
"prime_bundle_id": null,
"bundle_tier": null
}
}
],
"tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"registration_email": null,
"technical_installation_required": null,
"contact_number": null,
"id_doc": null
}
}
],
"netflix": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"bundle_id": null,
"product_id": null
}
}
],
"max": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"service_id": null,
"product_id": null
}
}
],
"orange_tv": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null
}
}
],
"orange_tv_libre": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"registration_email": null,
"service_id": null,
"product_id": null,
"password": null
}
}
],
"disney": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"type": "NETFLIX",
"catalogue_commercial_product_id": "7125",
"status": "ACTIVE",
"promotions": [
null
],
"add_ons": [
null
],
"free_units_packages": [
null
],
"devices_related_info": {
"devices": null,
"customer_financial_info": null,
"pre_booking": null,
"delivery_info": null
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"account_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"bundle_related_info": {
"id": null,
"legacy_id": null,
"catalogue_bundled_product_id": null,
"catalogue_bundled_commercial_product_id": null,
"mandatory": null
},
"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": [
null
],
"specific_data": {
"user_id": null,
"service_id": null,
"product_id": null
}
}
]
},
"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",
"fraud_check_status": "APPROVED",
"installation_order_id": "18395",
"contract_id": "MMMC2407247403552",
"contract_delivery_channel": "APPLICATION",
"origin": "NEW_SALE",
"app_id": 4,
"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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Required if 'legacy_id' filter is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | string (uuid) | Unique identifier of the account | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_customer_id | integer | Customer id the account id is linked to. Required if 'external_sell_id' is not provided. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dealer_id | string | Dealer id. Required if 'external_sell_id' is not provided. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financial_evaluation_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_sell_id | string | Legacy field to relate bundle to external sale operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchase_payment | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriptions | object | Set of subscriptions to include on bundle grouped by type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fraud_check_status | string
()
APPROVEDDENIEDUNDER_REVIEWDOCUMENTATION_REQUIRED | Current fraud check status for the bundle creation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_order_id | string | Id of the installation order related to the bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_id | string | Id of the contract generated | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_delivery_channel | string
()
APPLICATIONPAPEREMAILUNKNOWN | Delivery channel used to send the contract | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin | string
()
NEW_SALECROSS_SELLMIGRATIONADD_SUBSCRIPTIONUNKNOWN | Bundle process origin | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
app_id | integer | Application id according to MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "status",
"value": "ACTIVE"
}
]'Get promotions of 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
Subscription status filter
Bundle id the subscription is linked to.
Catalogue promotion identifier
OK Promotions found for 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,
"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",
"origin": "EXISTING_CLIENT"
}
]
}| 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/v2/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"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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 POST 'https://subscriptions.masstack.com/v2/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"
}'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,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Updates a subscription promotion with new data
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
HEADER PARAMETERS
Promotion data to replace
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
OK Promotion successfully updated
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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 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 PUT 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-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 '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}'Patches specific fields of a subscription promotion
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
HEADER PARAMETERS
Array of operations to apply to subscription promotion
[
{
"op": "add",
"path": "status",
"value": "CANCELLED"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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 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 PATCH 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-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 '[
{
"op": "add",
"path": "status",
"value": "CANCELLED"
}
]'Deactivate a subscription existing promotion
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
HEADER PARAMETERS
Promotion deactivation reason
{
"reason": "SUBSCRIPTION_DEACTIVATION"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason* | string
()
AUTOMATICALLY_REMOVEDMANUALLY_REMOVEDOTHERPROMOTION_INCOMPATIBILITYSUBSCRIPTION_DEACTIVATION | Reason for the cancellation/deactivation |
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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342/deactivate' \
-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 '{
"reason": "SUBSCRIPTION_DEACTIVATION"
}'Cancel a subscription existing promotion that is not already active
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
HEADER PARAMETERS
Promotion cancellation reason
{
"reason": "SUBSCRIPTION_DEACTIVATION"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason* | string
()
AUTOMATICALLY_REMOVEDMANUALLY_REMOVEDOTHERPROMOTION_INCOMPATIBILITYSUBSCRIPTION_DEACTIVATION | Reason for the cancellation/deactivation |
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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342/cancel' \
-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 '{
"reason": "SUBSCRIPTION_DEACTIVATION"
}'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
Subscription 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,
"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",
"origin": "EXISTING_CLIENT"
}
]
}| 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/v2/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'Get info for a specific promotion of an add-on
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
Promotion unique identifier
OK Promotion found for the add-on
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Patches specific fields of an add-on promotion
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
Promotion unique identifier
HEADER PARAMETERS
Array of operations to apply to add-on promotion
[
{
"op": "replace",
"path": "status",
"value": "CANCELLED"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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 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 PATCH 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-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 '[
{
"op": "replace",
"path": "status",
"value": "CANCELLED"
}
]'Get all promotions associated with a device
PATH PARAMETERS
Organization name
Subscription unique identifier
Device 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
Subscription status filter
OK Promotions found for the device
{
"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,
"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",
"origin": "EXISTING_CLIENT"
}
]
}| 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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/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'Get info for a specific promotion of a device
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
Promotion unique identifier
OK Promotion found for the device
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Patches specific fields of a device promotion
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
Promotion unique identifier
HEADER PARAMETERS
Array of operations to apply to device promotion
[
{
"op": "replace",
"path": "status",
"value": "CANCELLED"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_promotion_id": "124",
"commitments": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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",
"origin": "EXISTING_CLIENT"
}| 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 | |||||||||||||||||||||||||||||||||||||
origin | string
()
MIGRATIONEXISTING_CLIENTUNKNOWN | Promotion process origin. If not provided, it will be set to EXISTING_CLIENT by default | |||||||||||||||||||||||||||||||||||||
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 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 PATCH 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/promotions/27cdbb91-e380-4f83-a45f-94bf67400342' \
-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 '[
{
"op": "replace",
"path": "status",
"value": "CANCELLED"
}
]'Get all devices filtering. This endpoint cannot be called without a query parameter.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Mac address filter. Required if 'serial_number' filter is not provided
Serial number filter. Required if 'mac_address' filter is not provided
OK Devices found
[
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}
]| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/devices?mac_address=00-B0-D0-63-C2-26&serial_number=SN-48392A7F4B' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get all subscription devices associated to the subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Mac address 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",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}
]| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices?mac_address=00-B0-D0-63-C2-26' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new device to a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Add device data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
Created Device added to subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}'Get info for a specific device
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
OK Device found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Updates device's data
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
Array of operations to apply to the device
[
{
"op": "replace",
"path": "shipping_order_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Device patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": "SERIAL_NUMBER",
"id": "9876543-AB-345"
},
"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,
"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,
"legacy_account_id": "245655"
}| 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 | |||||||||||||||||||||||||||||||||||||
reservation_id | string | Id for device reservation | |||||||||||||||||||||||||||||||||||||
signature_process_id | string | Id of the resource containing subscriber valid signature to purchase device | |||||||||||||||||||||||||||||||||||||
shipping_order_id | string | Id of the shipping order related to the device according to logistic | |||||||||||||||||||||||||||||||||||||
pickup_order_id | string | Id of the pickup order related to the device according to reverse logistic | |||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
manufacturing_info | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||
legacy_account_id* | integer | Account ID associated with the subscription. Currently tied to MySim/Apollo storage. | |||||||||||||||||||||||||||||||||||||
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/v2/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": "shipping_order_id",
"value": "abc123"
}
]'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_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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/v2/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'Add an AddOn to a subscription.
PATH PARAMETERS
Organization name
Subscription unique identifier
Add AddOn to subscription body
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_add_on_legacy_id* | string | MySim/Apollo related id for the Add-On catalogue resource definition | ||
catalogue_add_on_id* | string | Catalogue add-on ID | ||
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 |
Created AddOn added to subscription
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_add_on_legacy_id* | string | MySim/Apollo related id for the Add-On catalogue resource definition | ||
catalogue_add_on_id* | string | Catalogue add-on ID | ||
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 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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"provider_product_id": "provider_product_id",
"provider_service_id": "d2af0bd9c71b42aaa258c9d9dc734bfc"
}'Get addOn (value added services) associated to the subscription by addon ID
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
OK Add-on associated to the subscription found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_add_on_legacy_id* | string | MySim/Apollo related id for the Add-On catalogue resource definition | ||
catalogue_add_on_id* | string | Catalogue add-on ID | ||
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 |
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Starts the deactivation process of the subscription AddOn.
PATH PARAMETERS
Organization name
Subscription unique identifier
AddOn unique identifier
Deactivate subscription AddOn data
{
"reason": "SUBSCRIBER_RESIGNATION"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason* | string
()
SUBSCRIBER_RESIGNATION | Reason for the deactivation |
Accepted Deactivation process started
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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/add_ons/0100cfa5-06e9-4572-976d-5287916adff1/deactivate' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "SUBSCRIBER_RESIGNATION"
}'Returns an array of Amazon Prime subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Amazon Prime internal ID for subscription operations
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "PRIME_1M_BUNDLE",
"prime_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"bundle_tier": "PRIME_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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/amazon_prime?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&entitlement_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-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
Bundle identifier
Amazon Prime subscription data
{
"pre_scoring_id": 1234,
"promotions": [
{
"catalogue_promotion_id": "1572"
}
],
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}{
"pre_scoring_id": 1234,
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Amazon Prime subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Amazon Prime subscription successfully added to the bundle
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "PRIME_1M_BUNDLE",
"prime_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"bundle_tier": "PRIME_HARD_OFFER"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Amazon Prime subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/amazon_prime' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"pre_scoring_id": 1234,
"promotions": [
{
"catalogue_promotion_id": "1572"
}
],
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}'Search Amazon Prime subscriptions matching given criteria, at least one of the query params is required. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Amazon Prime internal ID for subscription operations
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "PRIME_1M_BUNDLE",
"prime_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"bundle_tier": "PRIME_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/v2/orgs/yoigo/subscriptions/amazon_prime?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&entitlement_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Amazon Prime subscription by id. Specific type data is included
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "PRIME_1M_BUNDLE",
"prime_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"bundle_tier": "PRIME_HARD_OFFER"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Amazon Prime subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/amazon_prime/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of an Amazon Prime subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to apply to Amazon Prime specific data
[
{
"op": "add",
"path": "specific_data.entitlement_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"entitlement_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "PRIME_1M_BUNDLE",
"prime_bundle_id": "e773dac9-4b13-4287-bb97-a773200de581",
"bundle_tier": "PRIME_HARD_OFFER"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Amazon Prime subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.entitlement_id",
"value": "abc123"
}
]'Returns an array of Max subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Max internal ID for subscription operations
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/max?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-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
Bundle identifier
Max subscription data
{
"pre_scoring_id": 1234,
"promotions": [
{
"catalogue_promotion_id": "1572"
}
],
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}{
"pre_scoring_id": 1234,
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Max subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Max subscription successfully added to the bundle
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "beam-max-svod-monthly"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Max subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/max' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"pre_scoring_id": 1234,
"promotions": [
{
"catalogue_promotion_id": "1572"
}
],
"bundle_related_info": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P"
}
}'Search Max subscriptions matching given criteria, at least one of the query params is required. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Max internal ID for subscription operations
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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/v2/orgs/yoigo/subscriptions/max?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Max subscription by id. Specific type data is included
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "beam-max-svod-monthly"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Max subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/max/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Max subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to apply to Max specific data
[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "beam-max-svod-monthly"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Max subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Returns the set of mobile subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"msisdn": 34611223344,
"mobile_portability_info": {
"donor_operator_id": null,
"donor_data": null,
"portability_process_initial_date": null,
"internal_portability": null,
"donor_iccid": null,
"donor_billing_type": null,
"one_time_password_id": null
},
"sim": {
"type": null,
"iccid": null,
"imsi": null
}
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/mobile?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&msisdn=34611223344&imsi=214040000000000' \
-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
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"msisdn": 34611223344,
"mobile_portability_info": {
"donor_operator_id": null,
"donor_data": null,
"portability_process_initial_date": null,
"internal_portability": null,
"donor_iccid": null,
"donor_billing_type": null,
"one_time_password_id": null
},
"sim": {
"type": null,
"iccid": null,
"imsi": null
}
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/mobile?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&msisdn=34611223344&imsi=214040000000000' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Mobile 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"msisdn": 34611223344,
"mobile_portability_info": {
"donor_operator_id": 31,
"donor_data": {
"name": "string",
"surname": "string",
"second_surname": "string",
"id_doc": {
"id_type": null,
"id": null
}
},
"portability_process_initial_date": "2017-09-15T22:00:00Z",
"internal_portability": true,
"donor_iccid": "8934000000000000002",
"donor_billing_type": "PREPAY",
"one_time_password_id": "ee0881ff-6050-43bd-a4b3-b7e8fd0474d9"
},
"sim": {
"type": "ESIM",
"iccid": "12341234123412341234123412341234",
"imsi": 215051234512345
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Mobile subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/mobile/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the set of broadband subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Work order id according to mas-installations definition. Required if the 'legacy_id' and 'legacy_account_id' filters are not provided
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"access_id": "IUA-XXX",
"vacant_loop": true,
"territory_owner": "FIBMM01",
"access_reuse_info_allowed": true,
"legacy_service_id": "MYSIM_2331123",
"installation_address": {
"street_type": null,
"street_name": null,
"house_number": null,
"additional_info": null,
"city": null,
"province": null,
"country": null,
"post_code": null,
"address_code": null,
"address_additional_id": null
}
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/broadband?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&legacy_service_id=MYSIM_9395450' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search broadband subscriptions matching certain criteria. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Work order id according to mas-installations definition. Required if 'legacy_id' and 'legacy_account_id' filters are not provided
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"access_id": "IUA-XXX",
"vacant_loop": true,
"territory_owner": "FIBMM01",
"access_reuse_info_allowed": true,
"legacy_service_id": "MYSIM_2331123",
"installation_address": {
"street_type": null,
"street_name": null,
"house_number": null,
"additional_info": null,
"city": null,
"province": null,
"country": null,
"post_code": null,
"address_code": null,
"address_additional_id": null
}
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/broadband?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&legacy_service_id=MYSIM_9395450' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Broadband 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"access_id": "IUA-XXX",
"vacant_loop": true,
"territory_owner": "FIBMM01",
"access_reuse_info_allowed": true,
"legacy_service_id": "MYSIM_2331123",
"installation_address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Broadband subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/broadband/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns landline subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Landline fixed phone number
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"fixed_phone_number": "913312244",
"installation_address": {
"street_type": null,
"street_name": null,
"house_number": null,
"additional_info": null,
"city": null,
"province": null,
"country": null,
"post_code": null,
"address_code": null,
"address_additional_id": null
},
"contact_info": {
"name": null,
"surname": null,
"id_doc": null,
"phone_number": null,
"email_address": null
},
"fixed_portability_info": {
"donor_operator_id": null,
"scheduled_portability_date": null,
"internal_portability": null,
"installation_required": null,
"donor_data": null
}
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/landline?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&fixed_phone_number=34913319009' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search landline subscriptions matching certain criteria. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Landline fixed phone number
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"fixed_phone_number": "913312244",
"installation_address": {
"street_type": null,
"street_name": null,
"house_number": null,
"additional_info": null,
"city": null,
"province": null,
"country": null,
"post_code": null,
"address_code": null,
"address_additional_id": null
},
"contact_info": {
"name": null,
"surname": null,
"id_doc": null,
"phone_number": null,
"email_address": null
},
"fixed_portability_info": {
"donor_operator_id": null,
"scheduled_portability_date": null,
"internal_portability": null,
"installation_required": null,
"donor_data": null
}
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/landline?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&fixed_phone_number=34913319009' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get landline 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"fixed_phone_number": "913312244",
"installation_address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": "NIF",
"id": "5012341234"
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"fixed_portability_info": {
"donor_operator_id": 31,
"scheduled_portability_date": "2017-09-15T22:00:00Z",
"internal_portability": true,
"installation_required": false,
"donor_data": {
"name": "string",
"surname": "string",
"second_surname": "string",
"id_doc": {
"id_type": null,
"id": null
}
}
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Landline subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/landline/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of Orange TV subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/orange_tv?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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®istration_email=peter.sellers%40monty.com&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
Bundle identifier
Orange TV subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Orange TV subscription successfully added to the bundle
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}'Search Orange TV subscriptions matching given criteria, at least one of the query params is required. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/orange_tv?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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®istration_email=peter.sellers%40monty.com&service_id=masmovil003141592' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Orange TV subscription by id. Specific type data is included
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/orange_tv/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Orange TV subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to apply to Orange TV specific data
[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "yoigo123456789",
"product_id": "SP_OFFER_0200000"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Search Orange TV Libre subscriptions matching given criteria, at least one of the query params is required. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "Yoigo123456789",
"product_id": "SP_OFFER_0200000",
"password": "string"
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/orange_tv_libre?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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®istration_email=peter.sellers%40monty.com&service_id=masmovil003141592' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Orange Tv Libre subscription by id. Specific type data is included
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "Yoigo123456789",
"product_id": "SP_OFFER_0200000",
"password": "string"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV Libre subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/orange_tv_libre/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Orange TV Libre subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of operations to apply to Orange TV Libre specific data
[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "Yoigo123456789",
"product_id": "SP_OFFER_0200000",
"password": "string"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Orange TV Libre subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/orange_tv_libre/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Returns an array of Orange TV Libre subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"registration_email": "john.doe@mail.com",
"service_id": "Yoigo123456789",
"product_id": "SP_OFFER_0200000",
"password": "string"
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/orange_tv_libre?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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®istration_email=peter.sellers%40monty.com&service_id=masmovil003141592' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Retrieve an array of Disney subscriptions in a bundle.
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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 subscriptions by provider user id.
Filter subscriptions by provider service id.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/disney?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&user_id=123e4567-e89b-12d3-a456-426614174000&service_id=123e4567-e89b-12d3-a456-426614174000' \
-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
Bundle identifier
Disney subscription data.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "com.disney.yoigo.es.bundle.standard"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Disney subscription specific data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Disney subscription successfully added.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "com.disney.yoigo.es.bundle.standard"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Disney subscription specific data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "com.disney.yoigo.es.bundle.standard"
}
}'Retrieve a list of Disney subscriptions matching given criteria. At least one of the query parameters is required. Specific type data is included.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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 subscriptions by provider user id.
Filter subscriptions by provider service id.
Filter subscriptions by provider product id.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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/v2/orgs/yoigo/subscriptions/disney?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&user_id=123e4567-e89b-12d3-a456-426614174000&service_id=123e4567-e89b-12d3-a456-426614174000&product_id=com.disney.yoigo.es.bundle.standard' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Retrieve a specific Disney subscription by id. Specific type data is included
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "com.disney.yoigo.es.bundle.standard"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Disney subscription specific data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/disney/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Disney subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of update operations for the Disney subscription.
[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Disney subscription patched successfully.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"user_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"service_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "com.disney.yoigo.es.bundle.standard"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Disney subscription specific data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Retrieve a list of AgileTv subscriptions matching given criteria. At least one of the query parameters is required. Specific type data is included.
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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 subscriptions by provider service id.
Filter subscriptions by provider product id.
Filter subscriptions by primary status.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"product_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
"service_id": "f6e5d4c3-b2a1-4098-a7b6-c5d4e3f2a1b0",
"is_primary": 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/v2/orgs/yoigo/subscriptions/agile_tv?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=f6e5d4c3-b2a1-4098-a7b6-c5d4e3f2a1b0&product_id=a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6&is_primary=true' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the set of AgileTv subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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 subscriptions by provider service id.
Filter subscriptions by provider product id.
Filter subscriptions by primary status.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"product_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
"service_id": "f6e5d4c3-b2a1-4098-a7b6-c5d4e3f2a1b0",
"is_primary": 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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/agile_tv?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=agile-service-id-001&product_id=agile-product-standard&is_primary=true' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"product_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
"service_id": "f6e5d4c3-b2a1-4098-a7b6-c5d4e3f2a1b0",
"is_primary": true
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | AgileTv subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"product_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
"service_id": "f6e5d4c3-b2a1-4098-a7b6-c5d4e3f2a1b0",
"is_primary": true
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | AgileTv subscription specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Returns the set of Netflix subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Partner account id the subscription is linked to
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/netflix?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=572234234' \
-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
Bundle identifier
Netflix subscription data.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Netflix subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Netflix subscription successfully added.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Netflix subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
}'Search Netflix subscriptions matching certain criteria. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Partner account id the subscription is linked to
Registration email the subscription is linked to.
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"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/v2/orgs/yoigo/subscriptions/netflix?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=572234234®istration_email=peter.sellers%40monty.com' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Netflix 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Netflix subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/netflix/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Netflix subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of update operations for the Netflix subscription.
[
{
"op": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Netflix subscription patched successfully.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"service_id": "Me7b7b7b7-b7b7-b7b7-b7b7-b7b7b7b7b7b7",
"bundle_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc",
"product_id": "d2af0bd9-c71b-42aa-a258-c9d9dc734bfc"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Netflix subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/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": "add",
"path": "specific_data.service_id",
"value": "abc123"
}
]'Get subscription credit limits by organization ID and subscription ID
PATH PARAMETERS
Organization name
Subscription unique identifier
OK OK
[
{
"type": "ORANGE_TV_TOTAL_CREDIT_LIMIT",
"value": 1000,
"last_updated_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
type* | string
()
ORANGE_TV_TOTAL_CREDIT_LIMITMOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMITMOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMITMOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMITMOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMITLANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMITLANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMITLANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT | Credit limit type | ||
value* | number | Credit limit value | ||
last_updated_user | string | User that last updated the credit limit | ||
last_updated_date | string (date-time) | Date and time when the credit limit was last updated. 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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/credit_limits' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'get tariff change requests providing certain search criteria
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Change request status filter
Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
"catalogue_promotion_ids": [
"124",
"125"
]
}
}
]
}| 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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/tariff?offset=0&limit=50&date_scheduled=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new tariff change request for an existing subscription. The change request will be processed asynchronously
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
"catalogue_promotion_ids": [
"124",
"125"
]
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | |||||||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | |||||||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | |||||||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | |||||||||||||||||
parent_change_request | string | Parent change request id | |||||||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | |||||||||||||||||
request_user | string | User that requested the change | |||||||||||||||||
request_system | string | System that requested the change | |||||||||||||||||
specific_data* | object | Specific data for the tariff change request | |||||||||||||||||
| |||||||||||||||||||
Created Tariff change request successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | Change request unique identifier | ||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | ||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | ||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | ||
parent_change_request | string | Parent change request id | ||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | ||
request_user | string | User that requested the change | ||
request_system | string | System that requested the change |
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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/tariff' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
"catalogue_promotion_ids": [
"124",
"125"
]
}
}'get deactivation change requests providing certain search criteria
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Change request status filter
Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/deactivation?offset=0&limit=50&date_scheduled=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new deactivation change request for an existing subscription. The change request will be processed asynchronously
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_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 | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | |||||||||||||||||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | |||||||||||||||||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | |||||||||||||||||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | |||||||||||||||||||||||||||
parent_change_request | string | Parent change request id | |||||||||||||||||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | |||||||||||||||||||||||||||
request_user | string | User that requested the change | |||||||||||||||||||||||||||
request_system | string | System that requested the change | |||||||||||||||||||||||||||
specific_data* | object | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
Created Deactivation change request successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_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 | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | |||||||||||||||||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | |||||||||||||||||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | |||||||||||||||||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | |||||||||||||||||||||||||||
parent_change_request | string | Parent change request id | |||||||||||||||||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | |||||||||||||||||||||||||||
request_user | string | User that requested the change | |||||||||||||||||||||||||||
request_system | string | System that requested the change | |||||||||||||||||||||||||||
specific_data* | 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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Conflict A change request for the subscription with the change requested is still in progress
{
"code": "CHANGE_REQUEST_CONFLICT",
"message": "A change request for the subscription with the change requested is still in progress",
"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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/deactivation' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_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"
]
}
}'get email change requests providing certain search criteria
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Change request status filter
Change request date scheduled matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"registration_email": "newemail@test.com"
}
}
]
}| 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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/email?offset=0&limit=50&date_scheduled=2023-01-05T03%3A30%3A15Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new email change request for an existing subscription. The change request will be processed asynchronously
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"registration_email": "newemail@test.com"
}
}| Property | Type | Description | Constraints | Default | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | ||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | ||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | ||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | ||||||||||||
parent_change_request | string | Parent change request id | ||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | ||||||||||||
request_user | string | User that requested the change | ||||||||||||
request_system | string | System that requested the change | ||||||||||||
specific_data* | object | Specific data for the email change request | ||||||||||||
| ||||||||||||||
Created Email change request successfully created
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"registration_email": "newemail@test.com"
}
}| Property | Type | Description | Constraints | Default | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | ||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | ||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | ||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | ||||||||||||
parent_change_request | string | Parent change request id | ||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | ||||||||||||
request_user | string | User that requested the change | ||||||||||||
request_system | string | System that requested the change | ||||||||||||
specific_data* | object | Specific data for the email change request | ||||||||||||
| ||||||||||||||
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 | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Conflict A change request for the subscription with the change requested is still in progress
{
"code": "CHANGE_REQUEST_CONFLICT",
"message": "A change request for the subscription with the change requested is still in progress",
"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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/email' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"registration_email": "newemail@test.com"
}
}'Get info for a specific tariff change request
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request unique identifier
OK Tariff Change request found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com",
"specific_data": {
"catalogue_bundled_commercial_product_id": "8432_BUNDLED_3P",
"catalogue_promotion_ids": [
"124",
"125"
]
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Change request unique identifier | |||||||||||||||||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | |||||||||||||||||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | |||||||||||||||||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | |||||||||||||||||
parent_change_request | string | Parent change request id | |||||||||||||||||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | |||||||||||||||||
request_user | string | User that requested the change | |||||||||||||||||
request_system | string | System that requested the change | |||||||||||||||||
specific_data* | object | Specific data for the tariff change request | |||||||||||||||||
| |||||||||||||||||||
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 change request with the specified id was not found
{
"code": "CHANGE_REQUEST_NOT_FOUND",
"message": "No change request 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/tariff/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search subscription change requests providing certain search criteria
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Change request status filter
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com"
}
]
}| 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 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests?offset=0&limit=50' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get info for a specific change request
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request unique identifier
OK Change request found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | Change request unique identifier | ||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | ||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | ||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | ||
parent_change_request | string | Parent change request id | ||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | ||
request_user | string | User that requested the change | ||
request_system | string | System that requested the change |
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 change request with the specified id was not found
{
"code": "CHANGE_REQUEST_NOT_FOUND",
"message": "No change request 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update change request
PATH PARAMETERS
Organization name
Subscription unique identifier
Change request unique identifier
Array of operations to be applied to the change request fields
[
{
"op": "replace",
"path": "status",
"value": "FINISHED"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK OK
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"type": "TARIFF",
"status": "REQUESTED",
"date_scheduled": "2023-01-01T00:00:00Z",
"parent_change_request": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"reason": "SUBSCRIBER_REQUESTED",
"request_user": "asd@asd.com",
"request_system": "killflex.auth.masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | Change request unique identifier | ||
type | string
()
TARIFFDEACTIVATIONEMAIL | Change request type | ||
status | string
()
REQUESTEDON_HOLDIN_PROGRESSFINISHEDFAILEDCANCELED | Change request status | ||
date_scheduled | string (date-time) | Date and time when the change request is scheduled to be executed. Format according to ISO 8601 | ||
parent_change_request | string | Parent change request id | ||
reason* | string
()
SUBSCRIBER_REQUESTED | Reason for the change request | ||
request_user | string | User that requested the change | ||
request_system | string | System that requested the change |
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 change request with the specified id was not found
{
"code": "CHANGE_REQUEST_NOT_FOUND",
"message": "No change request 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/change_requests/0100cfa5-06e9-4572-976d-5287916adff1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "status",
"value": "FINISHED"
}
]'Get info for a specific commitment
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
Commitment unique identifier
OK Commitment found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Acquired commitment id | ||
legacy_id | integer | Legacy id for acquired commitment linked MySim/Apollo storage, to be deprecated but required when catalogue_term_id not available | ||
expiration_date | string (date-time) | End date according to ISO 8601 | ||
cancellation_date | string (date-time) | Cancellation date according to ISO 8601 | ||
cancellation_system | string | Info about the system that requested the commitment cancellation. It contains the mas-stack authentication audience info. N/A if not available | ||
cancellation_user | string | Info about the specific user that requested the commitment cancellation. N/A if not available |
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 commitment with the specified id was not found
{
"code": "COMMITMENT_NOT_FOUND",
"message": "No commitment 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342/commitments/00a96051-bb4a-498c-adab-95b1dd8e7222' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Updates commitment's data
PATH PARAMETERS
Organization name
Subscription unique identifier
Promotion unique identifier
Commitment unique identifier
Array of operations to apply to the commitment
[
{
"op": "replace",
"path": "cancellation_date",
"value": "2025-02-13T10:35:05Z"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Promotion commitment patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Acquired commitment id | ||
legacy_id | integer | Legacy id for acquired commitment linked MySim/Apollo storage, to be deprecated but required when catalogue_term_id not available | ||
expiration_date | string (date-time) | End date according to ISO 8601 | ||
cancellation_date | string (date-time) | Cancellation date according to ISO 8601 | ||
cancellation_system | string | Info about the system that requested the commitment cancellation. It contains the mas-stack authentication audience info. N/A if not available | ||
cancellation_user | string | Info about the specific user that requested the commitment cancellation. N/A if not available |
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 commitment with the specified id was not found
{
"code": "COMMITMENT_NOT_FOUND",
"message": "No commitment 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/promotions/27cdbb91-e380-4f83-a45f-94bf67400342/commitments/00a96051-bb4a-498c-adab-95b1dd8e7222' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "cancellation_date",
"value": "2025-02-13T10:35:05Z"
}
]'Get info for a specific commitment
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
Commitment unique identifier
OK Commitment found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Acquired commitment id | ||
legacy_id | integer | Legacy id for acquired commitment linked MySim/Apollo storage, to be deprecated but required when catalogue_term_id not available | ||
expiration_date | string (date-time) | End date according to ISO 8601 | ||
cancellation_date | string (date-time) | Cancellation date according to ISO 8601 | ||
cancellation_system | string | Info about the system that requested the commitment cancellation. It contains the mas-stack authentication audience info. N/A if not available | ||
cancellation_user | string | Info about the specific user that requested the commitment cancellation. N/A if not available |
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 commitment with the specified id was not found
{
"code": "COMMITMENT_NOT_FOUND",
"message": "No commitment 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/commitments/00a96051-bb4a-498c-adab-95b1dd8e7222' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Updates commitment's data
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
Commitment unique identifier
Array of operations to apply to the commitment
[
{
"op": "replace",
"path": "cancellation_date",
"value": "2025-02-13T10:35:05Z"
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Device commitment patched successfully
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 345,
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Acquired commitment id | ||
legacy_id | integer | Legacy id for acquired commitment linked MySim/Apollo storage, to be deprecated but required when catalogue_term_id not available | ||
expiration_date | string (date-time) | End date according to ISO 8601 | ||
cancellation_date | string (date-time) | Cancellation date according to ISO 8601 | ||
cancellation_system | string | Info about the system that requested the commitment cancellation. It contains the mas-stack authentication audience info. N/A if not available | ||
cancellation_user | string | Info about the specific user that requested the commitment cancellation. N/A if not available |
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 commitment with the specified id was not found
{
"code": "COMMITMENT_NOT_FOUND",
"message": "No commitment 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/commitments/00a96051-bb4a-498c-adab-95b1dd8e7222' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "cancellation_date",
"value": "2025-02-13T10:35:05Z"
}
]'Returns the set of Device Insurance subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/device_insurance?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=819230465' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new Device Insurance subscription to a bundle with the provided data
PATH PARAMETERS
Organization name
Bundle identifier
Device Insurance subscription data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | DeviceInsurance subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Device Insurance subscription successfully added
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | DeviceInsurance subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/device_insurance' \
-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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}'Search Device Insurance subscriptions matching certain criteria. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/device_insurance?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&service_id=819230465' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Device Insurance 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | DeviceInsurance subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/device_insurance/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update specific data of a Device Insurance subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Array of update operations for the Device Insurance subscription.
[
{
"op": "replace",
"path": "specific_data.service_id",
"value": 819230465
}
]| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
op* | string
()
addreplaceactivatedeactivatecancelmigrate | Operation to be performed between specific options inspired by IETF RFC6902 (https://datatracker.ietf.org/doc/html/rfc6902) | |||||||
path | string | Path to the field to be updated | |||||||
value | object | Value to use for the operation, any could be applicable | |||||||
| |||||||||
reason | string | Additional info about the reason why the operation is requested. Possible values described as "Status Change Reasons" at https://developers.masstack.com/en/guides/subscriptions/lifecycle | |||||||
OK Device Insurance subscription patched successfully.
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"device_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"service_id": "0819230465"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | DeviceInsurance subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/device_insurance/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"op": "replace",
"path": "specific_data.service_id",
"value": 819230465
}
]'Returns the set of Multisim subscriptions in a bundle
PATH PARAMETERS
Organization name
Bundle identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
Main subscription identifier
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"main_subscription_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"msisdn": 34611223344,
"sim": {
"type": null,
"iccid": null,
"imsi": null
}
}
}
]
}| 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/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/multisim?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&main=123e4567-e89b-12d3-a456-426614174000' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get Multisim 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,
"pre_scoring_id": "1564",
"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,
"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",
"origin": "EXISTING_CLIENT"
}
],
"add_ons": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 457345,
"catalogue_add_on_legacy_id": "124",
"catalogue_add_on_id": "124",
"creation_date": "2022-12-01T00:00:00Z",
"creation_system": "killflex.auth.masmovil.com",
"creation_user": "john.doe@masorange.es",
"last_updated_date": "2023-01-08T12:00:05Z",
"status": "CANCELLED",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"deactivation_system": "killflex.auth.masmovil.com",
"deactivation_user": "john.doe@masorange.es",
"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_packages_id": "124",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z"
}
],
"devices_related_info": {
"devices": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 756402,
"catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
"catalogue_device_id": "P09712MRC",
"reservation_id": "1567",
"signature_process_id": "18395",
"shipping_order_id": "18395",
"pickup_order_id": "P0000001",
"in_store_delivery_date": "2025-01-05T03:30:15Z",
"in_store_returned_date": "2025-01-05T03:30:15Z",
"manufacturing_info": {
"id_type": null,
"id": null
},
"serial_number": "9876543-AB-345",
"mac_address": "00-B0-D0-63-C2-26",
"imei": "AA-BBBBBB-CCCCCC-D",
"acquisition_type": "BORROWED",
"commitments": [
null
],
"insurable_amount": 135.49,
"legacy_account_id": "245655"
}
],
"customer_financial_info": {
"bank_declared_income": 0,
"business_name": "",
"observations": "blabla",
"professional_usage": false,
"activity_country": "es",
"doc_expiration_date": "2017-09-15T22:00:00Z",
"profession_code": "PRIVATE_SECTOR_WORKER",
"funds_origin_code": "3RD",
"occupation_sector_code": "SERV"
},
"pre_booking": {
"order_id": "123213asdsa",
"authorization_id": "",
"financial_entity": "BBVA",
"agreed_commercial_consents": true,
"agreed_gdpr": true,
"status": "ACCEPTED",
"granted_amount": 100,
"credit_line_amount": 10
},
"delivery_info": {
"contact_info": {
"name": "Juan",
"surname": "Perez Lopez",
"id_doc": {
"id_type": null,
"id": null
},
"phone_number": "696288378",
"email_address": "juan@hotmail.com"
},
"address": {
"street_type": "Calle",
"street_name": "Tellez",
"house_number": "12",
"additional_info": "Esc. Dcha 3 C",
"city": "Riaza",
"province": "Segovia",
"country": "es",
"post_code": "40500",
"address_code": "28000010758100012 OA 004C ",
"address_additional_id": "123443554"
},
"delivery_type": "CUSTOMER_ADDRESS",
"dealer_code": "1234"
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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"
}
],
"specific_data": {
"main_subscription_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"msisdn": 34611223344,
"sim": {
"type": "ESIM",
"iccid": "12341234123412341234123412341234",
"imsi": 215051234512345
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_id | integer | Legacy unique identifier of the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pre_scoring_id* | string | A subscriber scoring check is required before bundle creation request and the id returned from risk management system must be provided here | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 subscription applicable promotions according to catalogue definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add_ons | object[] | Ids of subscription 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_related_info | object | Info about devices associated to the subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
legacy_account_id | integer | Account id the subscription is linked to. Linked to MySim/Apollo storage, to be deprecated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specific_data | object | Multisim subscription including specific info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/orgs/yoigo/subscriptions/multisim/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Search multisim subscriptions matching certain criteria. Specific type data is included
PATH PARAMETERS
Organization name
QUERY PARAMETERS
Pagination offset
Pagination limit
Resource legacy ID
Account id the subscription is linked to. Required if the legacy_id, account_id, or legacy_bundle_id filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Bundle id the subscription is linked to. Required if the 'legacy_id', 'account_id', or 'legacy_account_id' filters are not provided. Linked to MySim/Apollo storage, to be deprecated.
Account id the subscription is linked to. Required if the 'legacy_id', 'legacy_account_id', or 'legacy_bundle_id' filters are not provided.
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
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.
Main subscription identifier. Required if msisdn or main_msisdn are not provided
MSISDN of the main subscription associated to the multisim subscription following E.164 format. Spanish country code is assumed if plus sign(+) is not included to indicate international format. Required if msisdn or main_subscription_id are not provided
OK OK
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"legacy_id": 54,
"pre_scoring_id": "1564",
"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,
"origin": null
}
],
"add_ons": [
{
"id": null,
"legacy_id": null,
"catalogue_add_on_legacy_id": null,
"catalogue_add_on_id": 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_packages_id": null,
"activation_date": null,
"deactivation_date": null
}
],
"devices_related_info": {
"devices": [
null
],
"customer_financial_info": {
"bank_declared_income": null,
"business_name": null,
"observations": null,
"professional_usage": null,
"activity_country": null,
"doc_expiration_date": null,
"profession_code": null,
"funds_origin_code": null,
"occupation_sector_code": null
},
"pre_booking": {
"order_id": null,
"authorization_id": null,
"financial_entity": null,
"agreed_commercial_consents": null,
"agreed_gdpr": null,
"status": null,
"granted_amount": null,
"credit_line_amount": null
},
"delivery_info": {
"contact_info": null,
"address": null,
"delivery_type": null,
"dealer_code": null
}
},
"last_status_update": "2023-01-05T03:30:15Z",
"last_status_reason": "FRAUD_CHECK_ONGOING",
"activation_date": "2023-01-01T00:00:00Z",
"deactivation_date": "2025-01-05T03:30:15Z",
"legacy_account_id": 245655,
"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
}
],
"specific_data": {
"main_subscription_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"msisdn": 34611223344,
"sim": {
"type": null,
"iccid": null,
"imsi": null
}
}
}
]
}| 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/v2/orgs/yoigo/subscriptions/multisim?offset=0&limit=50&legacy_id=0&legacy_account_id=572234234&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&msisdn=34611223344&main_subscription_id=123e4567-e89b-12d3-a456-426614174000&main_msisdn=34611223344' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the payment plan for a specific device in a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Device unique identifier
OK OK
Example not available for this response.
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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c/payment_plans' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'This endpoint allows to perform administration operations in batch mode via CSV file upload. More detailed documentation can be found here
PATH PARAMETERS
Organization name
CSV file containing the operations to be performed
{
"file": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
file* | string (binary) | Document content in binary format |
Accepted File processed successfully. This does not mean that all operations were successful, check the response body for details
{
"summary": {
"total": 100,
"success": 95,
"failed": 5
},
"results": [
{
"line": 1,
"operation": "CREATE",
"status": "SUCCESS",
"error": "Entity not found"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
summary* | object | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
results* | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Client error. Possible causes are malformed CSV, invalid operation type, missing required parameters, invalid parameter values.
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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/operations' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json' \
-F 'file=@/path/to/file'Get info for a specific contract associated with a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Contract unique identifier
OK Contract found
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"documents_contract_id": "12345678-1234-1234-1234-123456789012",
"documents_owner_id": "87654321-4321-4321-4321-210987654321",
"creation_date": "2025-01-05T03:30:15Z",
"creation_user": "john.doe@masorange.es",
"creation_system": "mas-subscriptions.auth.masmovil.com",
"last_updated_date": "2025-01-06T10:30:15Z",
"last_updated_user": "jane.smith@masorange.es"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Contract id | ||
documents_contract_id* | string | Documents service contract id | ||
documents_owner_id* | string | Documents service owner id | ||
creation_date | string (date-time) | Creation date according to ISO 8601 | ||
creation_user | string | User who created the contract | ||
creation_system | string | System that created the contract | ||
last_updated_date | string (date-time) | Last update date according to ISO 8601 | ||
last_updated_user | string | User who last updated the contract |
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 Contract not found
{
"error": {
"code": "FORBIDDEN_ORGANIZATION",
"message": "Access to organization not allowed",
"reference": "string"
}
}| 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/contracts/a570614e-8a66-4d93-b329-7a2c9d6f0ce8' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get all contracts associated with a subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
QUERY PARAMETERS
Pagination offset
Pagination limit
OK Contracts found for the subscription
{
"limit": 5,
"offset": 15,
"total": 33,
"items": [
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"documents_contract_id": "12345678-1234-1234-1234-123456789012",
"documents_owner_id": "87654321-4321-4321-4321-210987654321",
"creation_date": "2025-01-05T03:30:15Z",
"creation_user": "john.doe@masorange.es",
"creation_system": "mas-subscriptions.auth.masmovil.com",
"last_updated_date": "2025-01-06T10:30:15Z",
"last_updated_user": "jane.smith@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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/contracts?offset=0&limit=50' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Add a new contract to an existing subscription
PATH PARAMETERS
Organization name
Subscription unique identifier
Contract data
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"documents_contract_id": "12345678-1234-1234-1234-123456789012",
"documents_owner_id": "87654321-4321-4321-4321-210987654321",
"creation_date": "2025-01-05T03:30:15Z",
"creation_user": "john.doe@masorange.es",
"creation_system": "mas-subscriptions.auth.masmovil.com",
"last_updated_date": "2025-01-06T10:30:15Z",
"last_updated_user": "jane.smith@masorange.es"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Contract id | ||
documents_contract_id* | string | Documents service contract id | ||
documents_owner_id* | string | Documents service owner id | ||
creation_date | string (date-time) | Creation date according to ISO 8601 | ||
creation_user | string | User who created the contract | ||
creation_system | string | System that created the contract | ||
last_updated_date | string (date-time) | Last update date according to ISO 8601 | ||
last_updated_user | string | User who last updated the contract |
Created Contract successfully added
{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"documents_contract_id": "12345678-1234-1234-1234-123456789012",
"documents_owner_id": "87654321-4321-4321-4321-210987654321",
"creation_date": "2025-01-05T03:30:15Z",
"creation_user": "john.doe@masorange.es",
"creation_system": "mas-subscriptions.auth.masmovil.com",
"last_updated_date": "2025-01-06T10:30:15Z",
"last_updated_user": "jane.smith@masorange.es"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Contract id | ||
documents_contract_id* | string | Documents service contract id | ||
documents_owner_id* | string | Documents service owner id | ||
creation_date | string (date-time) | Creation date according to ISO 8601 | ||
creation_user | string | User who created the contract | ||
creation_system | string | System that created the contract | ||
last_updated_date | string (date-time) | Last update date according to ISO 8601 | ||
last_updated_user | string | User who last updated the contract |
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 POST 'https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/contracts' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
"documents_contract_id": "12345678-1234-1234-1234-123456789012",
"documents_owner_id": "87654321-4321-4321-4321-210987654321",
"creation_date": "2025-01-05T03:30:15Z",
"creation_user": "john.doe@masorange.es",
"creation_system": "mas-subscriptions.auth.masmovil.com",
"last_updated_date": "2025-01-06T10:30:15Z",
"last_updated_user": "jane.smith@masorange.es"
}'Get documents associated with a subscription contract
PATH PARAMETERS
Organization name
Subscription unique identifier
Contract unique identifier
OK Contract documents found
{
"documents": [
{
"url_expiration_date": "2023-01-27T03:44:52.000Z",
"public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
"media_type": "application/pdf",
"name": "my_doc_name",
"documents_contract_id": "a570614e-8a66-4d93-b329-7a2c9d6f0ce8"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
documents | 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/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/contracts/a570614e-8a66-4d93-b329-7a2c9d6f0ce8/documents' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'