masstack

V1
V2
API Overview Resources Schemas

Netflix Tv

Netflix provides users access to Netflix content across various application and platform combinations including mobile devices, smart TVs, and desktop computers.

Parameters

Name In Type Required Description
org_id path string true Tenant
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body CreateSubscription true ‘none’

Request body - JsonObject

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

{
  "external_id": "external_subscription_12345",
  "billing_event_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "channel": "WEB",
  "netflix_email": "test@email.com",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "netflix_phone": "+525512345678",
  "partner_account_id": 4567890123456789,
  "partner_charge_country": "ES",
  "preferred_language": "es-ES"
}
Name Type Required Description
external_id ExternalID false Identifier of the subscription on the CRM
billing_event_id BillingEventID false Reference identifier used for tracking/reconciliation. Max 1024 bytes.
bundle_id BundleID true Describes your bundle offers. Each of your offers should correspond to a unique BundleID.
channel Channel false Channel used to sign up for the Bundle.
netflix_email Email false Customer’s primary email address (standard email format).
netflix_offer_id OfferID true Pre-agreed UUID for each Netflix plan available in your bundle offers.
netflix_phone Phone false E.164 format. +[CountryCode][PhoneNumber]
partner_account_id PartnerAccountId true Partner Account Identifier (PAI) to associate a partner account with a Netflix account.
partner_charge_country PartnerChargeCountry false Two letter codes that conform to ISO 3166-1
preferred_language PreferredLanguage false Language preferred for contact.

Request example

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


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'external_id': 'external_subscription_12345',
  'billing_event_id': 'e307f177-091a-4840-9830-dda1c29eea44',
  'bundle_id': 'c2a45099-1cda-4178-83a8-02c02356ea01',
  'channel': 'WEB',
  'netflix_email': 'test@email.com',
  'netflix_offer_id': '2106f808-36e9-402d-bf37-f1f7fa04776b',
  'netflix_phone': '+525512345678',
  'partner_account_id': 4567890123456789,
  'partner_charge_country': 'ES',
  'preferred_language': 'es-ES'
}"

Responses

Code Meaning Description Schema
201 Created Enrolled in the entitlement offer successfully. WorkflowResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
409 Conflict Conflict [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body UpdateSubscription true ‘none’

Request body - JsonObject

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "external_id": "external_subscription_12345",
  "billing_event_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "channel": "WEB",
  "netflix_email": "test@email.com",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "netflix_phone": "+525512345678",
  "partner_charge_country": "ES",
  "preferred_language": "es-ES"
}
Name Type Required Description
external_id ExternalID false Identifier of the subscription on the CRM
billing_event_id BillingEventID false Reference identifier used for tracking/reconciliation. Max 1024 bytes.
bundle_id BundleID false Describes your bundle offers. Each of your offers should correspond to a unique BundleID.
channel Channel false Channel used to sign up for the Bundle.
netflix_email Email false Customer’s primary email address (standard email format).
netflix_offer_id OfferID false Pre-agreed UUID for each Netflix plan available in your bundle offers.
netflix_phone Phone false E.164 format. +[CountryCode][PhoneNumber]
partner_charge_country PartnerChargeCountry false Two letter codes that conform to ISO 3166-1
preferred_language PreferredLanguage false Language preferred for contact.

Request example

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


curl -X PATCH https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'external_id': 'external_subscription_12345',
  'billing_event_id': 'e307f177-091a-4840-9830-dda1c29eea44',
  'bundle_id': 'c2a45099-1cda-4178-83a8-02c02356ea01',
  'channel': 'WEB',
  'netflix_email': 'test@email.com',
  'netflix_offer_id': '2106f808-36e9-402d-bf37-f1f7fa04776b',
  'netflix_phone': '+525512345678',
  'partner_charge_country': 'ES',
  'preferred_language': 'es-ES'
}"

Responses

Code Meaning Description Schema
204 No Content Bundle updated successfully. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
404 Not Found Bundle not found [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
cancel_event_id query string false A reference for this change/transaction that can be used to track/reconcile with the trigger for this event.
cancel_reason query string false Indicates the reason for cancellation.
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
external_id query string false Netflix external identifier.

Request example

1
2
3
4
5


curl -X DELETE https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789?cancel_event_id='c02a6e17-7bdd-4c1d-a56b-764bcd1bcf01'&cancel_reason='CUSTOMER_REQUESTED_CANCEL'&external_id='4567890123456789' \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b"

Responses

Code Meaning Description Schema
204 No Content Canceled entitlement offer successfully. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
404 Not Found Bundle not found [Error]
500 Internal Server Error Internal Server Error [Error]
Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body GenerateUrl true ‘none’

Request body - JsonObject

1
2
3
4
5
6
7
8

{
  "channel": "WEB",
  "partner_charge_country": "ES",
  "promotion_id": "PROMO_ID",
  "token_error_url": "https://www.example.com/error/token",
  "type": "BUNDLE",
  "validity_duration_in_seconds": 43200
}
Name Type Required Description
channel BundleActivationChannel false Channel used to activate the Bundle.
partner_charge_country PartnerChargeCountry false Two letter codes that conform to ISO 3166-1
promotion_id PromotionID false PromotionID agreed upon with Netflix. Applies to prepaid promotion integrations.
token_error_url TokenErrorURL true URL where Netflix can redirect the user when token is invalid.
type TokenType true The token type indicates the purpose of the token and its intended usage.
validity_duration_in_seconds ValidityDurationInSeconds false For ACCOUNT_RECOVERY token type only. Up to 24 hours.

Request example

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


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/geturl \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'channel': 'WEB',
  'partner_charge_country': 'ES',
  'promotion_id': 'PROMO_ID',
  'token_error_url': 'https://www.example.com/error/token',
  'type': 'BUNDLE',
  'validity_duration_in_seconds': 43200
}"
Code Meaning Description Schema
201 Created New url with token was created successfully. GenerateUrlResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.

Request example

1
2
3
4
5


curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/status \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b"

Responses

Code Meaning Description Schema
200 OK Success GetSubscriptionStatusResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
startTimestamp query integer(int64) true A timestamp (specified in UNIX epoch seconds) to filter the events that have occurred on or after a specific time. Value must be within 14 days of the current time.
endTimestamp query integer(int64) true A timestamp (specified in UNIX epoch seconds) to filter the events that have occurred before a specific time. Value must be greater than startTimestamp and at least 15 minutes before the current time.
offset query string false Used when retrieving subsequent pages of events for the same time period.
events query array[string] false A case-sensitive comma-separated list of event types.
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.

Request example

1
2
3
4
5


curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/events?startTimestamp='1683710542'&endTimestamp='1683796942'&offset='7hysgqtGuaiqbVyqiIaNhjqqqq811lsU=='&events='BUNDLE_ACTIVATION,BUNDLE_PLAN_CHANGE'?startTimestamp=1683710542&endTimestamp=1683796942 \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b"

Responses

Code Meaning Description Schema
200 OK Success FetchSubscriptionEventsResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body Suspend true ‘none’

Request body - JsonObject

1
2
3
4
5

{
  "external_id": "external_subscription_12345",
  "suspend_event_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "reason": "PAYMENT_INSTRUMENT_FAILURE"
}
Name Type Required Description
external_id ExternalID false Identifier of the subscription on the CRM
suspend_event_id string true Partner-provided reference identifier for the suspend event.
reason string true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/suspend \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'external_id': 'external_subscription_12345',
  'suspend_event_id': 'c2a45099-1cda-4178-83a8-02c02356ea01',
  'reason': 'PAYMENT_INSTRUMENT_FAILURE'
}"

Responses

Code Meaning Description Schema
204 No Content Suspend done successfully. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body Reactivate true ‘none’

Request body - JsonObject

1
2
3
4

{
  "external_id": "external_subscription_12345",
  "reactivate_event_id": "c2a45099-1cda-4178-83a8-02c02356ea01"
}
Name Type Required Description
external_id ExternalID false Identifier of the subscription on the CRM
reactivate_event_id string true Partner-provided reference identifier for the reactivate event.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/reactivate \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'external_id': 'external_subscription_12345',
  'reactivate_event_id': 'c2a45099-1cda-4178-83a8-02c02356ea01'
}"

Responses

Code Meaning Description Schema
204 No Content Reactivate done successfully. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
body body EnrollDigitalVirgoSubscription true ‘none’

Request body - JsonObject

1
2
3
4

{
  "phone_number": "+525512345678",
  "pai": "123456"
}
Name Type Required Description
phone_number Phone true E.164 format. +[CountryCode][PhoneNumber]
pai Pai false Pai number to identify subscription.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/digitalvirgo \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  'phone_number': '+525512345678',
  'pai': '123456'
}"

Responses

Code Meaning Description Schema
201 Created Enrolled in the entitlement offer successfully. EnrollDigitalVirgoSubscriptionResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
org_id path string true Tenant
subscription_id path string true Subscription identifier. Corresponds to the Partner Account Identifier (PAI).
phone_number path string true The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber]
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.

Request example

1
2
3
4
5


curl -X DELETE https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/netflix/subscriptions/4567890123456789/digitalvirgo/+525512345678 \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b"

Responses

Code Meaning Description Schema
204 No Content Canceled entitlement offer successfully. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
404 Not Found Bundle not found [Error]
500 Internal Server Error Internal Server Error [Error]

Endpoints

Disney Tv

    Netflix Tv