Cdn API - CPG Source

<back to all web services

IapCustomerConvertRequest

Cdn.Api

The following routes are available for this service:
POST/IapCustomerConvertRequest
IapCustomerConvertRequest Parameters:
NameParameterData TypeRequiredDescription
CustIdbodylongNo
FromProductSkubodystringNo
ToProductSkubodystringNo
EntitlementIdbodystringNo
OfferingIdbodystringNo
ExpiresAtbodyDateTime?No
ReasonbodystringNo
IapCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerformRcCustomerNo
SubscriptionsformList<RcSubscription>No
ActiveEntitlementsformList<RcEntitlement>No
StatusformstringNo
ConversionModeformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
RcCustomer Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
ProjectIdformstringNo
FirstSeenAtformlong?No
LastSeenAtformlong?No
LastSeenAppVersionformstringNo
LastSeenCountryformstringNo
LastSeenPlatformformstringNo
ExtraformIDictionary<string, Object>No
RcSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
CustomerIdformstringNo
ProductIdformstringNo
StartsAtformlong?No
CurrentPeriodEndsAtformlong?No
GivesAccessformboolNo
AutoRenewalStatusformstringNo
StatusformstringNo
StoreformstringNo
StoreSubscriptionIdentifierformstringNo
ManagementUrlformstringNo
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.

POST /IapCustomerConvertRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustId: 0,
	FromProductSku: String,
	ToProductSku: String,
	EntitlementId: String,
	OfferingId: String,
	ExpiresAt: 0001-01-01,
	Reason: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Customer: 
	{
		Object: String,
		Id: String,
		ProjectId: String,
		FirstSeenAt: 0,
		LastSeenAt: 0,
		LastSeenAppVersion: String,
		LastSeenCountry: String,
		LastSeenPlatform: String
	},
	Subscriptions: 
	[
		{
			Object: String,
			Id: String,
			CustomerId: String,
			ProductId: String,
			StartsAt: 0,
			CurrentPeriodEndsAt: 0,
			GivesAccess: False,
			AutoRenewalStatus: String,
			Status: String,
			Store: String,
			StoreSubscriptionIdentifier: String,
			ManagementUrl: String
		}
	],
	ActiveEntitlements: 
	[
		{
			Object: String,
			Id: String,
			LookupKey: String,
			DisplayName: String,
			CreatedAt: 0,
			ExpiresAt: 0
		}
	],
	Status: String,
	ConversionMode: String,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}