API Overview Resources Schemas

Schemas

Errors

1
2
3
4
5
6
7
8


[
  {
    "code": "SomeErrorCode",
    "title": "TITLE_OF_THE_DOMAIN_ERROR",
    "details": "Some error happened",
    "ref": "https://developers.masstack.com/en/docs/apis_provision_doc_swagger/1/apioverview/#errors"
  }
]

Name	Type	Required	Description
anonymous	[Error]	false	none

Error

1
2
3
4
5
6


{
  "code": "SomeErrorCode",
  "title": "TITLE_OF_THE_DOMAIN_ERROR",
  "details": "Some error happened",
  "ref": "https://developers.masstack.com/en/docs/apis_provision_doc_swagger/1/apioverview/#errors"
}

Name	Type	Required	Description
code	string	false	none
title	string	false	none
details	string	false	none
ref	string	false	Optional reference URL (used by Netflix)

WorkflowResponse

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

Name	Type	Required	Description
message	string	false	none
workflowId	string	false	none
runId	string	false	none

CreateSubscriptionBody

1
2
3
4
5
6
7


{
  "subscriptionId": "ENT1664367665579",
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ]
}

Name	Type	Required	Description
subscriptionId	string	true	The subscriptionId will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled.
products	Products	true	List of product identifiers.

ModifySubscriptionBody

1
2
3
4
5
6


{
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ]
}

Name	Type	Required	Description
products	Products	true	List of product identifiers.

SuspendSubscriptionBody

1
2
3
4
5
6


{
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ]
}

Name	Type	Required	Description
products	Products	true	List of product identifiers.

ReactivateSubscriptionBody

1
2
3
4
5
6


{
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ]
}

Name	Type	Required	Description
products	Products	true	List of product identifiers.

SubscriptionStatus

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "entitled": "ACTIVE",
  "cancellation": "VOLUNTARY",
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ],
  "activated": "LINKED",
  "lastUpdated": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Description
entitled	string	true	Status field indicating whether the subject can watch content.
cancellation	string	false	Indicates why a subscription has been canceled.
products	Products	true	List of product identifiers.
activated	string	true	The status of an active subscription
lastUpdated	string(date-time)	true	ISO-8601 timestamp indicating when this subscription was last updated.

Property	Values
entitled	one of [ACTIVE, BILLING_HOLD, CANCELED, GRACE_PERIOD]
cancellation	one of [VOLUNTARY, INVOLUNTARY, PLAN_SWITCHED, ABUSE_REVOCATION, UNKNOWN]
activated	one of [LINKED, UNLINKED]

ActivationUrlRequest

1
2
3
4
5
6
7
8


{
  "products": [
    "com.disney.yoigo.es.bundle.basic",
    "com.disney.yoigo.es.bundle.premium"
  ],
  "country": "ES",
  "expireDate": "2021-01-01T00:00:00Z"
}

Name	Type	Required	Description
products	Products	true	List of product identifiers.
country	string	true	none
expireDate	string(date-time)	true	ISO-8601 timestamp indicating when the activation will expire

ActivationUrlResponse

1
2
3
4


{
  "expiryDate": "2023-06-20T14:32:45+02:00",
  "url": "https://www.example.com/activation/123"
}

Name	Type	Required	Description
expiryDate	string	false	Date when activation URL expires in ISO 8601 format.
url	string	true	Activation URL.

Products

1
2
3
4


[
  "com.disney.yoigo.es.bundle.basic",
  "com.disney.yoigo.es.bundle.premium"
]

None

CreateSubscription

 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.

EnrollDigitalVirgoSubscription

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.

EnrollDigitalVirgoSubscriptionResponse

1
2
3


{
  "id": 4567890123456789
}

Name	Type	Required	Description
id	SubscriptionId	false	Subscription identifier. Corresponds to the Partner Account Identifier (PAI).

GenerateUrl

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.

GenerateUrlResponse

1
2
3
4
5


{
  "expiry_date": "2023-05-20T14:32:45+02:00",
  "token": "73e90548-b839-423f-be6d-7ed715de656e",
  "requested_securitized_url": "https://www.sandbox.netflix.com/partner/home?ptoken=73e90548-b839-423f-be6d-7ed715de656e"
}

Name	Type	Required	Description
expiry_date	TokenExpiryDate	false	Date when token expires in ISO 8601 format.
token	Token	false	Token value is a unique identifier based on UUID
requested_securitized_url	RequestedSecuritizedUrl	false	RequestedSecuritizedUrl use token value to reference a Netflix url

GetSubscriptionStatusResponse

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


{
  "has_partner_mop": true,
  "product_type": "string",
  "subscription": {
    "plan": {
      "localized_type": "string",
      "type": "string"
    }
  },
  "bundle": {
    "id": "string",
    "offer_id": "string",
    "status": "string"
  }
}

Name	Type	Required	Description
has_partner_mop	boolean	false	none
product_type	string	false	none
subscription	Subscription	false	none
bundle	Bundle	false	none

Subscription

1
2
3
4
5
6


{
  "plan": {
    "localized_type": "string",
    "type": "string"
  }
}

Name	Type	Required	Description
plan	Plan	false	none

Plan

1
2
3
4


{
  "localized_type": "string",
  "type": "string"
}

Name	Type	Required	Description
localized_type	string	false	none
type	string	false	none

Bundle

1
2
3
4
5


{
  "id": "string",
  "offer_id": "string",
  "status": "string"
}

Name	Type	Required	Description
id	string	false	none
offer_id	string	false	none
status	string	false	none

FetchSubscriptionEventsResponse

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


{
  "events": [
    {
      "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
      "event_type": "BUNDLE_ACTIVATION",
      "netflix_event_id": "5a875d71-7deb-4693-a4d0-ae97aac9da8a",
      "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
      "original_netflix_transaction_id": "e307f177-091a-4840-9830-dda1c29eea44",
      "partner_account_id": 4567890123456789,
      "partner_reference_id": "e307f177-091a-4840-9830-dda1c29eea44",
      "timestamp": 1683710542
    }
  ],
  "next_page_offset": "7hysgqtGuaiqbVyqiIaNhjqqqq811lsU=="
}

Name	Type	Required	Description
events	[SubscriptionEvent]	false	List of zero or more Event objects that are relevant to the time period defined by startTimestamp and endTimestamp
next_page_offset	string	false	A value to retrieve subsequent pages for the same period.

Suspend

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

Reactivate

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.

UpdateSubscription

 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.

ExternalID

1

"external_subscription_12345"

Name	Type	Required	Description
anonymous	string	false	Identifier of the subscription on the CRM

BillingEventID

1

"e307f177-091a-4840-9830-dda1c29eea44"

Name	Type	Required	Description
anonymous	string	false	Reference identifier used for tracking/reconciliation. Max 1024 bytes.

BundleActivationChannel

1

"WEB"

Name	Type	Required	Description
anonymous	string	false	Channel used to activate the Bundle.

BundleID

1

"c2a45099-1cda-4178-83a8-02c02356ea01"

Name	Type	Required	Description
anonymous	string	false	Describes your bundle offers. Each of your offers should correspond to a unique BundleID.

Channel

1

"WEB"

Name	Type	Required	Description
anonymous	string	false	Channel used to sign up for the Bundle.

Email

1

"test@email.com"

Name	Type	Required	Description
anonymous	string	false	Customer’s primary email address (standard email format).

OfferID

1

"2106f808-36e9-402d-bf37-f1f7fa04776b"

Name	Type	Required	Description
anonymous	string	false	Pre-agreed UUID for each Netflix plan available in your bundle offers.

PartnerAccountId

1

4567890123456789

Name	Type	Required	Description
anonymous	string	false	Partner Account Identifier (PAI) to associate a partner account with a Netflix account.

PartnerChargeCountry

1

"ES"

Name	Type	Required	Description
anonymous	string	false	Two letter codes that conform to ISO 3166-1

Phone

1

"+525512345678"

Name	Type	Required	Description
anonymous	string	false	E.164 format. +[CountryCode][PhoneNumber]

Pai

1

"123456"

Name	Type	Required	Description
anonymous	string	false	Pai number to identify subscription.

PreferredLanguage

1

"es-ES"

Name	Type	Required	Description
anonymous	string	false	Language preferred for contact.

PromotionID

1

"PROMO_ID"

Name	Type	Required	Description
anonymous	string	false	PromotionID agreed upon with Netflix. Applies to prepaid promotion integrations.

SubscriptionEvent

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "event_type": "BUNDLE_ACTIVATION",
  "netflix_event_id": "5a875d71-7deb-4693-a4d0-ae97aac9da8a",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "original_netflix_transaction_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "partner_account_id": 4567890123456789,
  "partner_reference_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "timestamp": 1683710542
}

Name	Type	Required	Description
bundle_id	BundleID	false	Describes your bundle offers. Each of your offers should correspond to a unique BundleID.
event_type	string	false	Type of subscription event.
netflix_event_id	string	false	Unique ID per event (useful for deduplication).
netflix_offer_id	OfferID	false	Pre-agreed UUID for each Netflix plan available in your bundle offers.
original_netflix_transaction_id	string	false	Depends on event type. See API docs.
partner_account_id	PartnerAccountId	false	Partner Account Identifier (PAI) to associate a partner account with a Netflix account.
partner_reference_id	string	false	Depends on event type. See API docs.
timestamp	integer(int64)	false	Time in seconds since UNIX epoch when event occurred.

SubscriptionEventType

1

"BUNDLE_ACTIVATION"

Name	Type	Required	Description
anonymous	string	false	Subscription event type

SubscriptionId

1

4567890123456789

Name	Type	Required	Description
anonymous	string	false	Subscription identifier. Corresponds to the Partner Account Identifier (PAI).

Token

1

"73e90548-b839-423f-be6d-7ed715de656e"

Name	Type	Required	Description
anonymous	string	false	Token value is a unique identifier based on UUID

RequestedSecuritizedUrl

1

"https://www.sandbox.netflix.com/partner/home?ptoken=73e90548-b839-423f-be6d-7ed715de656e"

Name	Type	Required	Description
anonymous	string	false	RequestedSecuritizedUrl use token value to reference a Netflix url

TokenErrorURL

1

"https://www.example.com/error/token"

Name	Type	Required	Description
anonymous	string	false	URL where Netflix can redirect the user when token is invalid.

TokenExpiryDate

1

"2023-05-20T14:32:45+02:00"

Name	Type	Required	Description
anonymous	string	false	Date when token expires in ISO 8601 format.

TokenType

1

"BUNDLE"

Name	Type	Required	Description
anonymous	string	false	The token type indicates the purpose of the token and its intended usage.

ValidityDurationInSeconds

1

43200

Name	Type	Required	Description
anonymous	integer(int32)	false	For ACCOUNT_RECOVERY token type only. Up to 24 hours.

EndTimestamp

1

1683796942

Name	Type	Required	Description
anonymous	integer(int64)	false	Timestamp (UNIX epoch seconds) to filter events before a specific time.

StartTimestamp

1

1683710542

Name	Type	Required	Description
anonymous	integer(int64)	false	Timestamp (UNIX epoch seconds) to filter events on or after a specific time.

Product

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "code": "MAX_AVOD",
  "name": "MAX Ad VOD",
  "starts": 1616425200,
  "renews": 1616425200,
  "expires": 1616425200,
  "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
  "status": "ACTIVE",
  "trx_id": 1234567890
}

Name	Type	Required	Description
code	ProductCode	true	Alphanumeric URL safe product related unique identifier from partner, length to max 64 characters
name	ProductName	false	The name of the product
starts	ProductStarts	false	Start date/time to indicate since when user has authorization/subscription to the product; number of seconds since Unix Epoch.
renews	ProductRenews	false	Date/time when access to product will be re-evaluated; number of seconds since Unix Epoch.
expires	ProductExpires	false	End date/time to indicate when user will lose the authorization/subscription to the product; number of seconds since Unix Epoch.
sub_id	ProductSubId	false	The identifier of the subscription in the partner system. In MasMovil is service_id.
status	ProductStatus	false	Current state of the authorization/subscription {ACTIVE, PENDING, TERMINATED}
trx_id	TrxId	false	ID of the transaction that granted the user access to the product

ProductCode

1

"MAX_AVOD"

Name	Type	Required	Description
anonymous	string	false	Alphanumeric URL safe product related unique identifier from partner, length to max 64 characters

ProductName

1

"MAX Ad VOD"

Name	Type	Required	Description
anonymous	string	false	The name of the product

ProductStarts

1

1616425200

Name	Type	Required	Description
anonymous	integer(int64)	false	Start date/time to indicate since when user has authorization/subscription to the product; number of seconds since Unix Epoch.

ProductRenews

1

1616425200

Name	Type	Required	Description
anonymous	integer(int64)	false	Date/time when access to product will be re-evaluated; number of seconds since Unix Epoch.

ProductExpires

1

1616425200

Name	Type	Required	Description
anonymous	integer(int64)	false	End date/time to indicate when user will lose the authorization/subscription to the product; number of seconds since Unix Epoch.

ProductSubId

1

"1d732753-ae1f-45f8-82f7-7243d395b1ac"

Name	Type	Required	Description
anonymous	string	false	The identifier of the subscription in the partner system. In MasMovil is service_id.

ProductStatus

1

"ACTIVE"

Name	Type	Required	Description
anonymous	string	false	Current state of the authorization/subscription {ACTIVE, PENDING, TERMINATED}

Property	Values
anonymous	one of [ACTIVE, PENDING, TERMINATED]

TrxId

1

1234567890

Name	Type	Required	Description
anonymous	string	false	ID of the transaction that granted the user access to the product

CreateSubscriptionHBO

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


{
  "service_id": 1234567890123456,
  "external_id": 1234567890123456,
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
service_id	ServiceId	true	Service identifier in HBO. Corresponds to Subscription Id.
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
country	Country	true	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

CreateSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

UpdateSubscriptionHBO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29


{
  "external_id": 1234567890123456,
  "country": "ES",
  "reason": "PRODUCT_CANCELED",
  "products_to_add": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ],
  "products_to_remove": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
reason	Reason	false	Reason for the cancellation
products_to_add	[Product]	false	none
products_to_remove	[Product]	false	none

UpdateSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

CancelSubscriptionHBO

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


{
  "external_id": 1234567890123456,
  "reason": "PRODUCT_CANCELED",
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
reason	Reason	true	Reason for the cancellation
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

CancelSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

GetSubscriptionResponseHBO

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


{
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
products	[Product]	false	none

GenerateActivationUrlHBO

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


{
  "external_id": 1234567890123456,
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

GenerateActivationURLResponseHBO

1
2
3


{
  "url": "https://www.example.com/activation/123"
}

Name	Type	Required	Description
url	ActivationURL	false	Activation URL.

ActivateSubscriptionHBO

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


{
  "external_id": 1234567890123456,
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

ActivateSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

ReactivateSubscriptionHBO

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


{
  "external_id": 1234567890123456,
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

ReactivateSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

SuspendSubscriptionHBO

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


{
  "external_id": 1234567890123456,
  "reason": "PRODUCT_CANCELED",
  "country": "ES",
  "products": [
    {
      "code": "MAX_AVOD",
      "name": "MAX Ad VOD",
      "starts": 1616425200,
      "renews": 1616425200,
      "expires": 1616425200,
      "sub_id": "1d732753-ae1f-45f8-82f7-7243d395b1ac",
      "status": "ACTIVE",
      "trx_id": 1234567890
    }
  ]
}

Name	Type	Required	Description
external_id	ExternalId	true	Partner user identifier in HBO. It’s the Id in CRM.
reason	Reason	true	Reason for the cancellation
country	Country	false	Country code. ISO 3166-1 alpha-2 code.
products	[Product]	true	none

SuspendSubscriptionResponseHBO

1
2
3
4
5


{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}

None

ServiceId

1

1234567890123456

Name	Type	Required	Description
anonymous	string	false	Service identifier in HBO. Corresponds to Subscription Id.

ExternalId

1

1234567890123456

Name	Type	Required	Description
anonymous	string	false	Partner user identifier in HBO. It’s the Id in CRM.

Country

1

"ES"

Name	Type	Required	Description
anonymous	string	false	Country code. ISO 3166-1 alpha-2 code.

Reason

1

"PRODUCT_CANCELED"

Name	Type	Required	Description
anonymous	string	false	Reason for the cancellation

Property	Values
anonymous	one of [PRODUCT_CANCELED, PRODUCT_CHANGED, OFFER_EXPIRED]

ActivationURL

1

"https://www.example.com/activation/123"

Name	Type	Required	Description
anonymous	string	false	Activation URL.

InsuranceCreationRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


{
  "documentId": "00000000F",
  "firstName": "juan",
  "lastName1": "perez",
  "lastName2": "perez",
  "msisdn": "666666666",
  "address": "paseo de castellana, 4, 002B",
  "email": "d@g.com",
  "zipCode": "28000",
  "locality": "madrid",
  "province": "madrid",
  "language": "allowed values: es => castellano, eu=> euskera, ga=>gallego, ca=>catalán",
  "sfid": "1234",
  "brand": "string",
  "model": "string",
  "price": 2.2,
  "clientType": "Autónomo",
  "invoicePayment": true,
  "productType": "Móvil",
  "imei": "string",
  "terminalSaleDate": "2022-01-31T23:00:00Z",
  "entity": "string",
  "officeCode": "string",
  "dc": "string",
  "accountNumber": "string",
  "billingCycle": "string",
  "salesChannel": "string"
}

Name	Type	Required	Description
documentId	string	true	none
firstName	string	true	none
lastName1	string	false	none
lastName2	string	false	none
msisdn	string	false	none
address	string	false	none
email	string	true	none
zipCode	string	false	none
locality	string	false	none
province	string	false	none
language	string	true	none
sfid	string	false	none
brand	string	true	none
model	string	true	none
price	number	true	none
clientType	string	false	none
invoicePayment	boolean	false	none
productType	string	false	none
imei	string	false	none
terminalSaleDate	string	false	none
entity	string	false	none
officeCode	string	false	none
dc	string	false	none
accountNumber	string	false	none
billingCycle	string	false	none
salesChannel	string	false	none

InsuranceCreationResponseDTO

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


{
  "requestId": "string",
  "policyNumber": "string",
  "monthlyFee": 2.2,
  "annualFee": 2.2,
  "franchise": true,
  "franchiseAmount": 2.2,
  "theft": true,
  "monthlyNetFee": 2.2,
  "annualNetFee": 2.2,
  "annualLea": 2.2,
  "monthlyLea": 2.2,
  "annualIps": 2.2,
  "monthlyIps": 2.2,
  "annualConsortium": 2.2,
  "monthlyConsortium": 2.2,
  "firstAnnualLea": 2.2,
  "firstMonthlyConsortium": 2.2,
  "firstAnnualIps": 2.2,
  "firstAnnualNetFee": 2.2,
  "firstAnnualFee": 2.2
}

Name	Type	Required	Description
requestId	string	false	none
policyNumber	string	false	none
monthlyFee	number	false	none
annualFee	number	false	none
franchise	boolean	false	none
franchiseAmount	number	false	none
theft	boolean	false	none
monthlyNetFee	number	false	none
annualNetFee	number	false	none
annualLea	number	false	none
monthlyLea	number	false	none
annualIps	number	false	none
monthlyIps	number	false	none
annualConsortium	number	false	none
monthlyConsortium	number	false	none
firstAnnualLea	number	false	none
firstMonthlyConsortium	number	false	none
firstAnnualIps	number	false	none
firstAnnualNetFee	number	false	none
firstAnnualFee	number	false	none

CancelInsuranceRequest

1
2
3
4


{
  "policyNumber": "string",
  "document": "string"
}

Name	Type	Required	Description
policyNumber	string	true	Número de póliza
document	string	false	Documento del asegurado

ActivateInsuranceRequest

1
2
3
4
5
6
7
8


{
  "externalReference": "string",
  "requestId": "string",
  "policyNumber": "string",
  "imei": "string",
  "document": "string",
  "subscriptionId": "string"
}

Name	Type	Required	Description
externalReference	string	false	Referencia externa para la activación
requestId	string	true	Identificador único para la solicitud
policyNumber	string	true	Número de póliza
imei	string	true	IMEI del dispositivo
document	string	true	Documento del asegurado
subscriptionId	string	false	Identificador de la suscripción

TerminateInsuranceRequest

1
2
3
4
5


{
  "policyNumber": "string",
  "reason": "string",
  "document": "string"
}

Name	Type	Required	Description
policyNumber	string	true	Número de póliza
reason	string	false	Motivo de la baja
document	string	false	Documento del asegurado

InsuranceIssueRequestDTO

1
2
3
4
5
6
7
8


{
  "requestId": "00000000JIUSCS",
  "policyNumber": "87912HDH",
  "imei": "imei",
  "msisdn": "666666666",
  "document": "000000000K",
  "subscriptionId": "SNMC893CNIE"
}

Name	Type	Required	Description
requestId	string	false	none
policyNumber	string	false	none
imei	string	false	none
msisdn	string	false	none
document	string	false	none
subscriptionId	string	false	none

InsuranceIssueResponseDTO

1
2
3
4
5
6
7
8
9


{
  "requestId": "string",
  "policyNumber": "string",
  "monthlyFee": 2.2,
  "annualFee": 2.2,
  "franchise": true,
  "franchiseAmount": 2.2,
  "theft": true
}

Name	Type	Required	Description
requestId	string	false	none
policyNumber	string	false	none
monthlyFee	number	false	none
annualFee	number	false	none
franchise	boolean	false	none
franchiseAmount	number	false	none
theft	boolean	false	none

InsuranceCancellationRequestDTO

1
2
3
4
5


{
  "policyNumber": "87912HDH",
  "document": "000000000K",
  "reason": "Reason is..."
}

Name	Type	Required	Description
policyNumber	string	false	none
document	string	false	none
reason	string	false	none

InsuranceCancellationResponseDTO

1
2
3


{
  "result": true
}

Name	Type	Required	Description
result	boolean	false	none

InsuranceInfoResponseDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41


{
  "certificateNumber": "string",
  "imei": "string",
  "brand": {
    "name": "string"
  },
  "model": {
    "description": "string"
  },
  "phoneNumber": "string",
  "document": "string",
  "firstName": "string",
  "lastName1": "string",
  "lastName2": "string",
  "address": "string",
  "number": "string",
  "city": "string",
  "zipCode": "string",
  "policyNumber": "string",
  "province": "string",
  "effectiveDate": "2022-01-31T23:00:00Z",
  "email": "string",
  "sold": true,
  "cancelled": true,
  "cancellationDate": "2022-01-31T23:00:00Z",
  "serialNumber": "string",
  "paymentMethod": {
    "description": "string"
  },
  "clientType": {
    "name": "string"
  },
  "billPayment": true,
  "withdrawal": true,
  "withdrawalDate": "2022-01-31T23:00:00Z",
  "emitted": true,
  "language": {
    "name": "string"
  },
  "accident": true
}

Name	Type	Required	Description
certificateNumber	string	false	none
imei	string	false	none
brand	NameDTO	false	none
model	DescriptionDTO	false	none
phoneNumber	string	false	none
document	string	false	none
firstName	string	false	none
lastName1	string	false	none
lastName2	string	false	none
address	string	false	none
number	string	false	none
city	string	false	none
zipCode	string	false	none
policyNumber	string	false	none
province	string	false	none
effectiveDate	string	false	none
email	string	false	none
sold	boolean	false	none
cancelled	boolean	false	none
cancellationDate	string	false	none
serialNumber	string	false	none
paymentMethod	DescriptionDTO	false	none
clientType	NameDTO	false	none
billPayment	boolean	false	none
withdrawal	boolean	false	none
withdrawalDate	string	false	none
emitted	boolean	false	none
language	NameDTO	false	none
accident	boolean	false	none

NameDTO

1
2
3


{
  "name": "string"
}

Name	Type	Required	Description
name	string	false	none

DescriptionDTO

1
2
3


{
  "description": "string"
}

Name	Type	Required	Description
description	string	false	none

errorResponseDto

1
2
3
4


{
  "code": "string",
  "message": "string"
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

ProcessResponse

1
2
3
4


{
  "message": "message",
  "processId": "processId"
}

Name	Type	Required	Description
message	string	false	none
processId	string	false	none