ServiceStack Home (Live)

<back to all web services

Subscriptions

Requires Authentication
The following routes are available for this service:
All Verbs/account/subscription
GET/Subscriptions
namespace MyApp.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Subscriptions() = 
        member val Section:String = null with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Activated:Boolean = new Boolean() with get,set
        member val PurchasedOrderId:Nullable<Int32> = new Nullable<Int32>() with get,set

    type SkuType =
        | Product = 0
        | PerDev = 1
        | PerCore = 2
        | Site = 3
        | Support = 4
        | Training = 5
        | Register = 6
        | Payment = 7

    [<Flags>]
    type LicenseFeature =
        | 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

    type LicenseType =
        | Free = 0
        | FreeIndividual = 1
        | FreeOpenSource = 2
        | Indie = 3
        | Business = 4
        | Enterprise = 5
        | TextIndie = 6
        | TextBusiness = 7
        | OrmLiteIndie = 8
        | OrmLiteBusiness = 9
        | RedisIndie = 10
        | RedisBusiness = 11
        | AwsIndie = 12
        | AwsBusiness = 13
        | Trial = 14
        | Site = 15
        | TextSite = 16
        | RedisSite = 17
        | OrmLiteSite = 18

    [<AllowNullLiteral>]
    type Sku() = 
        member val Id:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val Type:SkuType = new SkuType() with get,set
        member val Feature:LicenseFeature = new LicenseFeature() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Notes:String = null with get,set
        [<Ignore>]
        member val MinQty:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val MaxQty:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Price:Int32 = new Int32() with get,set
        member val Plan:String = null with get,set
        member val DiscountOff:Int32 = new Int32() with get,set
        member val DiscountLabelOff:String = null with get,set
        member val ActualPrice:Int32 = new Int32() with get,set
        member val IsPlan:Boolean = new Boolean() with get,set
        member val IsRenewal:Boolean = new Boolean() with get,set
        member val SubscriptionDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ExpiryDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TrialPeriodDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SupportQty:Int32 = new Int32() with get,set
        member val CoresQty:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val LicenseType:LicenseType = new LicenseType() with get,set
        member val Active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LicenseKey() = 
        member val Ref:String = null with get,set
        member val Name:String = null with get,set
        member val Type:LicenseType = new LicenseType() with get,set
        member val Meta:Int64 = new Int64() with get,set
        member val Hash:String = null with get,set
        member val Halg:String = null with get,set
        member val Expiry:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Subscription() = 
        member val Id:Int32 = new Int32() with get,set
        member val CustomerId:Int32 = new Int32() with get,set
        member val Email:String = null with get,set
        member val SkuId:Int32 = new Int32() with get,set
        member val SkuName:String = null with get,set
        member val SkuType:SkuType = new SkuType() with get,set
        member val Code:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val SupportQuantity:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val IsPlan:Boolean = new Boolean() with get,set
        member val IsRenewal:Boolean = new Boolean() with get,set
        member val SubscriptionDurationDays:Int32 = new Int32() with get,set
        member val RenewalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LicenseRef:String = null with get,set
        member val LicenseName:String = null with get,set
        member val LicenseAddress:String = null with get,set
        member val LicenseType:LicenseType = new LicenseType() with get,set
        member val ExpiryDate:DateTime = new DateTime() with get,set
        member val LicenseKey:LicenseKey = null with get,set
        member val LicenseKeyText:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StripeSubscriptionId:String = null with get,set
        member val EmailId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EmailRenewalId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EmailExpiredId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RenewalSubscriptionId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ExternalRef:String = null with get,set
        member val Notes:String = null with get,set
        member val Error:String = null with get,set

    [<AllowNullLiteral>]
    type OrderDetail() = 
        member val Id:Int32 = new Int32() with get,set
        member val OrderId:Int32 = new Int32() with get,set
        member val SkuId:Int32 = new Int32() with get,set
        member val SkuType:SkuType = new SkuType() with get,set
        member val Price:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type OrderAnalyticData() = 
        member val ProductName:String = null with get,set
        member val SubTotal:Int32 = new Int32() with get,set
        member val CouponId:String = null with get,set
        member val Discount:Int32 = new Int32() with get,set
        member val Tax:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val Paid:Boolean = new Boolean() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val ModifiedBy:String = null with get,set
        member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledReason:String = null with get,set
        member val OrderDetails:ResizeArray<OrderDetail> = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionsResponse() = 
        member val Section:String = null with get,set
        member val SupportQuantity:Int32 = new Int32() with get,set
        member val ActiveSku:Sku = null with get,set
        member val ActiveSubscription:Subscription = null with get,set
        member val InActiveSubscriptions:ResizeArray<Subscription> = null with get,set
        member val PurchasedOrder:OrderAnalyticData = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

F# Subscriptions DTOs

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
		}
	}
}