ServiceStack Home (Live)

Subscriptions

The following routes are available for this service:
All Verbs	/account/subscription
GET	/Subscriptions

**Subscriptions** Parameters:
Name	Parameter	Data Type	Required
Section	query	string	No
Success	query	bool	No
Activated	query	bool	No
PurchasedOrderId	query	int?	No

**SubscriptionsResponse** Parameters:
Name	Parameter	Data Type	Required
Section	form	string	No
SupportQuantity	form	int	No
ActiveSku	form	Sku	No
ActiveSubscription	form	Subscription	No
InActiveSubscriptions	form	List<Subscription>	No
PurchasedOrder	form	OrderAnalyticData	No
ResponseStatus	form	ResponseStatus	No

**Sku** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ProductId	form	int	No
Type	form	SkuType	No
Feature	form	LicenseFeature	No
Code	form	string	No
Name	form	string	No
Notes	form	string	No
MinQty	form	int?	No
MaxQty	form	int?	No
Price	form	int	No
Plan	form	string	No
DiscountOff	form	int	No
DiscountLabelOff	form	string	No
ActualPrice	form	int	No
IsPlan	form	bool	No
IsRenewal	form	bool	No
SubscriptionDurationDays	form	int?	No
ExpiryDurationDays	form	int?	No
TrialPeriodDays	form	int?	No
SupportQty	form	int	No
CoresQty	form	int?	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
LicenseType	form	LicenseType	No
Active	form	bool	No

**SkuType** Enum:
Product
PerDev
PerCore
Site
Support
Training
Register
Payment

**LicenseFeature** Enum:
Name	Value
None	0
Free	0
Premium	1
Text	2
Client	4
Common	8
Redis	16
RedisSku	18
OrmLite	32
OrmLiteSku	34
ServiceStack	64
Server	128
Razor	256
Admin	512
Aws	1024
AwsSku	1026
All	2047

**LicenseType** Enum:
Free
FreeIndividual
FreeOpenSource
Indie
Business
Enterprise
TextIndie
TextBusiness
OrmLiteIndie
OrmLiteBusiness
RedisIndie
RedisBusiness
AwsIndie
AwsBusiness
Trial
Site
TextSite
RedisSite
OrmLiteSite

**Subscription** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CustomerId	form	int	No
Email	form	string	No
SkuId	form	int	No
SkuName	form	string	No
SkuType	form	SkuType	No
Code	form	string	No
Quantity	form	int	No
SupportQuantity	form	int	No
Total	form	int	No
IsPlan	form	bool	No
IsRenewal	form	bool	No
SubscriptionDurationDays	form	int	No
RenewalDate	form	DateTime?	No
LicenseRef	form	string	No
LicenseName	form	string	No
LicenseAddress	form	string	No
LicenseType	form	LicenseType	No
ExpiryDate	form	DateTime	No
LicenseKey	form	LicenseKey	No
LicenseKeyText	form	string	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
CancelledDate	form	DateTime?	No
StripeSubscriptionId	form	string	No
EmailId	form	int?	No
EmailRenewalId	form	int?	No
EmailExpiredId	form	int?	No
RenewalSubscriptionId	form	int?	No
ExternalRef	form	string	No
Notes	form	string	No
Error	form	string	No

**LicenseKey** Parameters:
Name	Parameter	Data Type	Required
Ref	form	string	No
Name	form	string	No
Type	form	LicenseType	No
Meta	form	long	No
Hash	form	string	No
Halg	form	string	No
Expiry	form	DateTime	No

**OrderAnalyticData** Parameters:
Name	Parameter	Data Type	Required
ProductName	form	string	No
SubTotal	form	int	No
CouponId	form	string	No
Discount	form	int	No
Tax	form	int	No
Total	form	int	No
Paid	form	bool	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
ModifiedBy	form	string	No
CancelledDate	form	DateTime?	No
CancelledReason	form	string	No
OrderDetails	form	List<OrderDetail>	No

**OrderDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
OrderId	form	int	No
SkuId	form	int	No
SkuType	form	SkuType	No
Price	form	int	No
Description	form	string	No
Quantity	form	int	No
Total	form	int	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 /account/subscription HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	section: String,
	success: False,
	activated: False,
	purchasedOrderId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	section: String,
	supportQuantity: 0,
	activeSku: 
	{
		id: 0,
		productId: 0,
		type: Product,
		feature: 0,
		code: String,
		name: String,
		notes: String,
		maxQty: 0,
		price: 0,
		plan: String,
		discountOff: 0,
		discountLabelOff: String,
		actualPrice: 0,
		isPlan: False,
		isRenewal: False,
		subscriptionDurationDays: 0,
		expiryDurationDays: 0,
		trialPeriodDays: 0,
		supportQty: 0,
		coresQty: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		licenseType: Free,
		active: False
	},
	activeSubscription: 
	{
		id: 0,
		customerId: 0,
		email: String,
		skuId: 0,
		skuName: String,
		skuType: Product,
		code: String,
		quantity: 0,
		supportQuantity: 0,
		total: 0,
		isPlan: False,
		isRenewal: False,
		subscriptionDurationDays: 0,
		renewalDate: 0001-01-01,
		licenseRef: String,
		licenseName: String,
		licenseAddress: String,
		licenseType: Free,
		expiryDate: 0001-01-01,
		licenseKey: 
		{
			ref: String,
			name: String,
			type: Free,
			meta: 0,
			hash: String,
			halg: String,
			expiry: 0001-01-01
		},
		licenseKeyText: String,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		cancelledDate: 0001-01-01,
		stripeSubscriptionId: String,
		emailId: 0,
		emailRenewalId: 0,
		emailExpiredId: 0,
		renewalSubscriptionId: 0,
		externalRef: String,
		notes: String,
		error: String
	},
	inActiveSubscriptions: 
	[
		{
			id: 0,
			customerId: 0,
			email: String,
			skuId: 0,
			skuName: String,
			skuType: Product,
			code: String,
			quantity: 0,
			supportQuantity: 0,
			total: 0,
			isPlan: False,
			isRenewal: False,
			subscriptionDurationDays: 0,
			renewalDate: 0001-01-01,
			licenseRef: String,
			licenseName: String,
			licenseAddress: String,
			licenseType: Free,
			expiryDate: 0001-01-01,
			licenseKey: 
			{
				ref: String,
				name: String,
				type: Free,
				meta: 0,
				hash: String,
				halg: String,
				expiry: 0001-01-01
			},
			licenseKeyText: String,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			cancelledDate: 0001-01-01,
			stripeSubscriptionId: String,
			emailId: 0,
			emailRenewalId: 0,
			emailExpiredId: 0,
			renewalSubscriptionId: 0,
			externalRef: String,
			notes: String,
			error: String
		}
	],
	purchasedOrder: 
	{
		productName: String,
		subTotal: 0,
		couponId: String,
		discount: 0,
		tax: 0,
		total: 0,
		paid: False,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		modifiedBy: String,
		cancelledDate: 0001-01-01,
		cancelledReason: String,
		orderDetails: 
		[
			{
				id: 0,
				orderId: 0,
				skuId: 0,
				skuType: Product,
				price: 0,
				description: String,
				quantity: 0,
				total: 0
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}