Cdn API - CPG Source

<back to all web services

IapSubscriptionGetRequest

Cdn.Api

The following routes are available for this service:
GET/IapSubscriptionRequest
IapSubscriptionGetRequest Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdquerystringNo
IncludeTransactionsqueryboolNo
IncludeEntitlementsqueryboolNo
IapSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionformRcSubscriptionNo
TransactionsformList<RcTransaction>No
EntitlementsformList<RcEntitlement>No
StatusformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
RcSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
CustomerIdformstringNo
ProductIdformstringNo
StartsAtformlong?No
CurrentPeriodEndsAtformlong?No
GivesAccessformboolNo
AutoRenewalStatusformstringNo
StatusformstringNo
StoreformstringNo
StoreSubscriptionIdentifierformstringNo
ManagementUrlformstringNo
ExtraformIDictionary<string, Object>No
RcTransaction Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
PurchasedAtformlong?No
ProductStoreIdentifierformstringNo
ExpirationDateformlong?No
EffectiveExpirationDateformlong?No
ExtraformIDictionary<string, Object>No
RcEntitlement Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
LookupKeyformstringNo
DisplayNameformstringNo
CreatedAtformlong?No
ExpiresAtformlong?No
ExtraformIDictionary<string, Object>No

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Subscription: 
	{
		Object: String,
		Id: String,
		CustomerId: String,
		ProductId: String,
		StartsAt: 0,
		CurrentPeriodEndsAt: 0,
		GivesAccess: False,
		AutoRenewalStatus: String,
		Status: String,
		Store: String,
		StoreSubscriptionIdentifier: String,
		ManagementUrl: String
	},
	Transactions: 
	[
		{
			Object: String,
			Id: String,
			PurchasedAt: 0,
			ProductStoreIdentifier: String,
			ExpirationDate: 0,
			EffectiveExpirationDate: 0
		}
	],
	Entitlements: 
	[
		{
			Object: String,
			Id: String,
			LookupKey: String,
			DisplayName: String,
			CreatedAt: 0,
			ExpiresAt: 0
		}
	],
	Status: String,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}