Provision API
Disney provides users access to Disney content across various application and platform combinations including mobile devices, smart TVs, and desktop computers. A direct integration provides opportunities for partners to enhance their digital experiences for their existing users or to make digital offerings available for new users.
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
body*required CreateSubscriptionBody (body) | ‘none’ |
Request body - instance of CreateSubscriptionBody
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. |
Request example
|
|
Responses
Code | Description | Schema |
---|---|---|
202 | The operation request was successfully accepted and returned the workflow initiation data. | WorkflowResponse |
400 | Bad Request | [Error] |
401 | Unauthorized request | [Error] |
500 | Internal Server Error | [Error] |
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
body*required ModifySubscriptionBody (body) | ‘none’ |
Request body - instance of ModifySubscriptionBody
Name | Type | Required | Description |
---|---|---|---|
products | Products | true | List of product identifiers. |
Request example
|
|
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
product*required string (query) | name of an optional product for this operation |
Request example
|
|
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | Get subscription status request successful | SubscriptionStatus |
400 | Bad Request | [Error] |
401 | Unauthorized request | [Error] |
500 | Internal Server Error | [Error] |
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
body SuspendSubscriptionBody (body) | ‘none’ |
Request body - instance of SuspendSubscriptionBody
Name | Type | Required | Description |
---|---|---|---|
products | Products | true | List of product identifiers. |
Request example
|
|
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
body ReactivateSubscriptionBody (body) | ‘none’ |
Request body - instance of ReactivateSubscriptionBody
Name | Type | Required | Description |
---|---|---|---|
products | Products | true | List of product identifiers. |
Request example
|
|
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
subscription_id*required string (path) | The subscription_id will be sent as the entitlement ID, an unique identifier of product(s) to which a customer is entitled. |
Request-Correlation-Id*required string (header) | A reference for this transaction that can be used to track it. |
body*required ActivationUrlRequest (body) | ‘none’ |
Request body - instance of ActivationUrlRequest
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 |
Request example
|
|
Responses
Code | Description | Schema |
---|---|---|
201 | New url with token was created successfully. | ActivationUrlResponse |
400 | Bad Request | [Error] |
401 | Unauthorized request | [Error] |
500 | Internal Server Error | [Error] |
Parameters
Name | Description |
---|---|
org_id*required string (path) | The tennant, which will be sent as the provider of the subscription. |
user_id*required string (path) | The user_id will be used as the primary identifier for an external user/purchase, and be unique across billing and CRM systems. |
Request example
Endpoints
Disney Tv
- POST
/orgs/{org_id}/tv/disney/users/{user_id}/orgs/{org_id}/tv/disney/users/{user_id}
- PATCH
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}
- DELETE
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}
- GET
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}
- POST
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/suspend/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/suspend
- POST
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/reactivate/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/reactivate
- POST
/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/activation_url/orgs/{org_id}/tv/disney/users/{user_id}/subscriptions/{subscription_id}/activation_url
- POST
/orgs/{org_id}/tv/disney/users/{user_id}/callbacks/activate/orgs/{org_id}/tv/disney/users/{user_id}/callbacks/activate