API Overview Resources Schemas

Schemas

Errors

1
2
3
4
5
6
7


[
  {
    "code": "SomeErrorCode",
    "title": "TITLE_OF_THE_DOMAIN_ERROR",
    "details": "Some error happened"
  }
]

Name	Type	Required	Description
anonymous	[Error]	false	none

Error

1
2
3
4
5


{
  "code": "SomeErrorCode",
  "title": "TITLE_OF_THE_DOMAIN_ERROR",
  "details": "Some error happened"
}

Name	Type	Required	Description
code	string	false	none
title	string	false	none
details	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.

CreateSubscriptionResponse

1
2
3
4
5


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

None

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.

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

Products

1
2
3
4


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

None