| All Verbs | /account/subscription | ||
|---|---|---|---|
| GET | /Subscriptions |
export class Subscriptions
{
public section: string;
public success: boolean;
public activated: boolean;
public purchasedOrderId?: number;
public constructor(init?: Partial<Subscriptions>) { (Object as any).assign(this, init); }
}
export enum SkuType
{
Product = 'Product',
PerDev = 'PerDev',
PerCore = 'PerCore',
Site = 'Site',
Support = 'Support',
Training = 'Training',
Register = 'Register',
Payment = 'Payment',
}
// @Flags()
export enum 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,
}
export enum LicenseType
{
Free = 'Free',
FreeIndividual = 'FreeIndividual',
FreeOpenSource = 'FreeOpenSource',
Indie = 'Indie',
Business = 'Business',
Enterprise = 'Enterprise',
TextIndie = 'TextIndie',
TextBusiness = 'TextBusiness',
OrmLiteIndie = 'OrmLiteIndie',
OrmLiteBusiness = 'OrmLiteBusiness',
RedisIndie = 'RedisIndie',
RedisBusiness = 'RedisBusiness',
AwsIndie = 'AwsIndie',
AwsBusiness = 'AwsBusiness',
Trial = 'Trial',
Site = 'Site',
TextSite = 'TextSite',
RedisSite = 'RedisSite',
OrmLiteSite = 'OrmLiteSite',
}
export class Sku
{
public id: number;
public productId: number;
public type: SkuType;
public feature: LicenseFeature;
public code: string;
public name: string;
public notes: string;
// @Ignore()
public minQty?: number;
public maxQty?: number;
public price: number;
public plan: string;
public discountOff: number;
public discountLabelOff: string;
public actualPrice: number;
public isPlan: boolean;
public isRenewal: boolean;
public subscriptionDurationDays?: number;
public expiryDurationDays?: number;
public trialPeriodDays?: number;
public supportQty: number;
public coresQty?: number;
public createdDate: string;
public modifiedDate: string;
public licenseType: LicenseType;
public active: boolean;
public constructor(init?: Partial<Sku>) { (Object as any).assign(this, init); }
}
export class LicenseKey
{
public ref: string;
public name: string;
public type: LicenseType;
public meta: number;
public hash: string;
public halg: string;
public expiry: string;
public constructor(init?: Partial<LicenseKey>) { (Object as any).assign(this, init); }
}
export class Subscription
{
public id: number;
public customerId: number;
public email: string;
public skuId: number;
public skuName: string;
public skuType: SkuType;
public code: string;
public quantity: number;
public supportQuantity: number;
public total: number;
public isPlan: boolean;
public isRenewal: boolean;
public subscriptionDurationDays: number;
public renewalDate?: string;
public licenseRef: string;
public licenseName: string;
public licenseAddress: string;
public licenseType: LicenseType;
public expiryDate: string;
public licenseKey: LicenseKey;
public licenseKeyText: string;
public createdDate: string;
public modifiedDate: string;
public cancelledDate?: string;
public stripeSubscriptionId: string;
public emailId?: number;
public emailRenewalId?: number;
public emailExpiredId?: number;
public renewalSubscriptionId?: number;
public externalRef: string;
public notes: string;
public error: string;
public constructor(init?: Partial<Subscription>) { (Object as any).assign(this, init); }
}
export class OrderDetail
{
public id: number;
public orderId: number;
public skuId: number;
public skuType: SkuType;
public price: number;
public description: string;
public quantity: number;
public total: number;
public constructor(init?: Partial<OrderDetail>) { (Object as any).assign(this, init); }
}
export class OrderAnalyticData
{
public productName: string;
public subTotal: number;
public couponId: string;
public discount: number;
public tax: number;
public total: number;
public paid: boolean;
public createdDate: string;
public modifiedDate: string;
public modifiedBy: string;
public cancelledDate?: string;
public cancelledReason: string;
public orderDetails: OrderDetail[];
public constructor(init?: Partial<OrderAnalyticData>) { (Object as any).assign(this, init); }
}
export class SubscriptionsResponse
{
public section: string;
public supportQuantity: number;
public activeSku: Sku;
public activeSubscription: Subscription;
public inActiveSubscriptions: Subscription[];
public purchasedOrder: OrderAnalyticData;
public responseStatus: ResponseStatus;
public constructor(init?: Partial<SubscriptionsResponse>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}