HBO Tv

Create a subscription

POST /orgs/{org_id}/tv/hbo/subscriptions

Parameters

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

Request body - JsonObject

 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

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/subscriptions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  '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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The creation operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Cancel a subscription

PUT /orgs/{org_id}/tv/hbo/subscriptions/{service_id}/cancel

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	CancelSubscriptionHBO	true	‘none’

Request body - JsonObject

 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

Request example

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



curl -X PUT https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/subscriptions/4567890123456789/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  '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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The cancel operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Update a subscription

PATCH /orgs/{org_id}/tv/hbo/subscriptions/{service_id}

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	UpdateSubscriptionHBO	true	‘none’

Request body - JsonObject

 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

Request example

 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



curl -X PATCH https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/subscriptions/4567890123456789 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  '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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The update operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Subscription not found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Get HBO subscription

The API provides the HBO subscription for a client

GET /orgs/{org_id}/tv/hbo/subscriptions/{service_id}

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.

Request example

1
2
3
4
5



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

Responses

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

Generate activation URL

Generate an activation URL to redirect to an HBO flow

POST /orgs/{org_id}/tv/hbo/subscriptions/{service_id}/activation_url

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	GenerateActivationUrlHBO	true	‘none’

Request body - JsonObject

 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

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/subscriptions/4567890123456789/activation_url \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  '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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Activation URL successfully generated.	GenerateActivationURLResponseHBO
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Activate a subscription

POST /orgs/{org_id}/tv/hbo/subscriptions/{service_id}/activate

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	ActivateSubscriptionHBO	true	‘none’

Request body - JsonObject

 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

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/subscriptions/4567890123456789/activate \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 2106f808-36e9-402d-bf37-f1f7fa04776b" \
 --data-raw "{
  '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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The activate operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Reactivate a subscription

POST /orgs/{org_id}/tv/hbo/subscriptions/{service_id}/reactivate

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	ReactivateSubscriptionHBO	true	‘none’

Request body - JsonObject

 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

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/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': 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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The reactivation operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Subscription not found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Suspend a subscription

POST /orgs/{org_id}/tv/hbo/subscriptions/{service_id}/suspend

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
org_id	path	string	true	Tenant
service_id	path	ServiceId	true	Service identifier. Corresponds to the Subscription Id in HBO.
body	body	SuspendSubscriptionHBO	true	‘none’

Request body - JsonObject

 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

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v2/orgs/masmovil/tv/hbo/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': 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
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	The suspension operation request was successfully accepted, returned the request external reference identifier.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Subscription not found	[Error]
500	Internal Server Error	Internal Server Error	[Error]