Cdn API - CPG Source

IapSubscriptionGetRequest

Cdn.Api

The following routes are available for this service:
GET	/IapSubscriptionRequest

**IapSubscriptionGetRequest** Parameters:
Name	Parameter	Data Type	Required
SubscriptionId	query	string	No
IncludeTransactions	query	bool	No
IncludeEntitlements	query	bool	No

**IapSubscriptionResponse** Parameters:
Name	Parameter	Data Type	Required
Subscription	form	RcSubscription	No
Transactions	form	List<RcTransaction>	No
Entitlements	form	List<RcEntitlement>	No
Status	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**RcSubscription** Parameters:
Name	Parameter	Data Type	Required
Object	form	string	No
Id	form	string	No
CustomerId	form	string	No
ProductId	form	string	No
StartsAt	form	long?	No
CurrentPeriodEndsAt	form	long?	No
GivesAccess	form	bool	No
AutoRenewalStatus	form	string	No
Status	form	string	No
Store	form	string	No
StoreSubscriptionIdentifier	form	string	No
ManagementUrl	form	string	No
Extra	form	IDictionary<string, Object>	No

**RcTransaction** Parameters:
Name	Parameter	Data Type	Required
Object	form	string	No
Id	form	string	No
PurchasedAt	form	long?	No
ProductStoreIdentifier	form	string	No
ExpirationDate	form	long?	No
EffectiveExpirationDate	form	long?	No
Extra	form	IDictionary<string, Object>	No

**RcEntitlement** Parameters:
Name	Parameter	Data Type	Required
Object	form	string	No
Id	form	string	No
LookupKey	form	string	No
DisplayName	form	string	No
CreatedAt	form	long?	No
ExpiresAt	form	long?	No
Extra	form	IDictionary<string, Object>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /IapSubscriptionRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IapSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Entitlements xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Models.Iap">
    <d2p1:RcEntitlement>
      <d2p1:CreatedAt>0</d2p1:CreatedAt>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:ExpiresAt>0</d2p1:ExpiresAt>
      <d2p1:Extra xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LookupKey>String</d2p1:LookupKey>
      <d2p1:Object>String</d2p1:Object>
    </d2p1:RcEntitlement>
  </Entitlements>
  <Status>String</Status>
  <Subscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Models.Iap">
    <d2p1:AutoRenewalStatus>String</d2p1:AutoRenewalStatus>
    <d2p1:CurrentPeriodEndsAt>0</d2p1:CurrentPeriodEndsAt>
    <d2p1:CustomerId>String</d2p1:CustomerId>
    <d2p1:Extra xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:GivesAccess>false</d2p1:GivesAccess>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:ManagementUrl>String</d2p1:ManagementUrl>
    <d2p1:Object>String</d2p1:Object>
    <d2p1:ProductId>String</d2p1:ProductId>
    <d2p1:StartsAt>0</d2p1:StartsAt>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Store>String</d2p1:Store>
    <d2p1:StoreSubscriptionIdentifier>String</d2p1:StoreSubscriptionIdentifier>
  </Subscription>
  <Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Models.Iap">
    <d2p1:RcTransaction>
      <d2p1:EffectiveExpirationDate>0</d2p1:EffectiveExpirationDate>
      <d2p1:ExpirationDate>0</d2p1:ExpirationDate>
      <d2p1:Extra xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Object>String</d2p1:Object>
      <d2p1:ProductStoreIdentifier>String</d2p1:ProductStoreIdentifier>
      <d2p1:PurchasedAt>0</d2p1:PurchasedAt>
    </d2p1:RcTransaction>
  </Transactions>
</IapSubscriptionResponse>