| All Verbs | /account/subscription | ||
|---|---|---|---|
| GET | /Subscriptions |
"use strict";
export class Subscriptions {
/** @param {{section?:string,success?:boolean,activated?:boolean,purchasedOrderId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
section;
/** @type {boolean} */
success;
/** @type {boolean} */
activated;
/** @type {?number} */
purchasedOrderId;
}
/** @typedef {'Product'|'PerDev'|'PerCore'|'Site'|'Support'|'Training'|'Register'|'Payment'} */
export var SkuType;
(function (SkuType) {
SkuType["Product"] = "Product"
SkuType["PerDev"] = "PerDev"
SkuType["PerCore"] = "PerCore"
SkuType["Site"] = "Site"
SkuType["Support"] = "Support"
SkuType["Training"] = "Training"
SkuType["Register"] = "Register"
SkuType["Payment"] = "Payment"
})(SkuType || (SkuType = {}));
/** @typedef {number} */
export var LicenseFeature;
(function (LicenseFeature) {
LicenseFeature[LicenseFeature["None"] = 0] = "None"
LicenseFeature[LicenseFeature["Free"] = 0] = "Free"
LicenseFeature[LicenseFeature["Premium"] = 1] = "Premium"
LicenseFeature[LicenseFeature["Text"] = 2] = "Text"
LicenseFeature[LicenseFeature["Client"] = 4] = "Client"
LicenseFeature[LicenseFeature["Common"] = 8] = "Common"
LicenseFeature[LicenseFeature["Redis"] = 16] = "Redis"
LicenseFeature[LicenseFeature["RedisSku"] = 18] = "RedisSku"
LicenseFeature[LicenseFeature["OrmLite"] = 32] = "OrmLite"
LicenseFeature[LicenseFeature["OrmLiteSku"] = 34] = "OrmLiteSku"
LicenseFeature[LicenseFeature["ServiceStack"] = 64] = "ServiceStack"
LicenseFeature[LicenseFeature["Server"] = 128] = "Server"
LicenseFeature[LicenseFeature["Razor"] = 256] = "Razor"
LicenseFeature[LicenseFeature["Admin"] = 512] = "Admin"
LicenseFeature[LicenseFeature["Aws"] = 1024] = "Aws"
LicenseFeature[LicenseFeature["AwsSku"] = 1026] = "AwsSku"
LicenseFeature[LicenseFeature["All"] = 2047] = "All"
})(LicenseFeature || (LicenseFeature = {}));
/** @typedef {'Free'|'FreeIndividual'|'FreeOpenSource'|'Indie'|'Business'|'Enterprise'|'TextIndie'|'TextBusiness'|'OrmLiteIndie'|'OrmLiteBusiness'|'RedisIndie'|'RedisBusiness'|'AwsIndie'|'AwsBusiness'|'Trial'|'Site'|'TextSite'|'RedisSite'|'OrmLiteSite'} */
export var LicenseType;
(function (LicenseType) {
LicenseType["Free"] = "Free"
LicenseType["FreeIndividual"] = "FreeIndividual"
LicenseType["FreeOpenSource"] = "FreeOpenSource"
LicenseType["Indie"] = "Indie"
LicenseType["Business"] = "Business"
LicenseType["Enterprise"] = "Enterprise"
LicenseType["TextIndie"] = "TextIndie"
LicenseType["TextBusiness"] = "TextBusiness"
LicenseType["OrmLiteIndie"] = "OrmLiteIndie"
LicenseType["OrmLiteBusiness"] = "OrmLiteBusiness"
LicenseType["RedisIndie"] = "RedisIndie"
LicenseType["RedisBusiness"] = "RedisBusiness"
LicenseType["AwsIndie"] = "AwsIndie"
LicenseType["AwsBusiness"] = "AwsBusiness"
LicenseType["Trial"] = "Trial"
LicenseType["Site"] = "Site"
LicenseType["TextSite"] = "TextSite"
LicenseType["RedisSite"] = "RedisSite"
LicenseType["OrmLiteSite"] = "OrmLiteSite"
})(LicenseType || (LicenseType = {}));
export class Sku {
/** @param {{id?:number,productId?:number,type?:SkuType,feature?:LicenseFeature,code?:string,name?:string,notes?:string,minQty?:number,maxQty?:number,price?:number,plan?:string,discountOff?:number,discountLabelOff?:string,actualPrice?:number,isPlan?:boolean,isRenewal?:boolean,subscriptionDurationDays?:number,expiryDurationDays?:number,trialPeriodDays?:number,supportQty?:number,coresQty?:number,createdDate?:string,modifiedDate?:string,licenseType?:LicenseType,active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
productId;
/** @type {SkuType} */
type;
/** @type {LicenseFeature} */
feature;
/** @type {string} */
code;
/** @type {string} */
name;
/** @type {string} */
notes;
/** @type {?number} */
minQty;
/** @type {?number} */
maxQty;
/** @type {number} */
price;
/** @type {string} */
plan;
/** @type {number} */
discountOff;
/** @type {string} */
discountLabelOff;
/** @type {number} */
actualPrice;
/** @type {boolean} */
isPlan;
/** @type {boolean} */
isRenewal;
/** @type {?number} */
subscriptionDurationDays;
/** @type {?number} */
expiryDurationDays;
/** @type {?number} */
trialPeriodDays;
/** @type {number} */
supportQty;
/** @type {?number} */
coresQty;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {LicenseType} */
licenseType;
/** @type {boolean} */
active;
}
export class LicenseKey {
/** @param {{ref?:string,name?:string,type?:LicenseType,meta?:number,hash?:string,halg?:string,expiry?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ref;
/** @type {string} */
name;
/** @type {LicenseType} */
type;
/** @type {number} */
meta;
/** @type {string} */
hash;
/** @type {string} */
halg;
/** @type {string} */
expiry;
}
export class Subscription {
/** @param {{id?:number,customerId?:number,email?:string,skuId?:number,skuName?:string,skuType?:SkuType,code?:string,quantity?:number,supportQuantity?:number,total?:number,isPlan?:boolean,isRenewal?:boolean,subscriptionDurationDays?:number,renewalDate?:string,licenseRef?:string,licenseName?:string,licenseAddress?:string,licenseType?:LicenseType,expiryDate?:string,licenseKey?:LicenseKey,licenseKeyText?:string,createdDate?:string,modifiedDate?:string,cancelledDate?:string,stripeSubscriptionId?:string,emailId?:number,emailRenewalId?:number,emailExpiredId?:number,renewalSubscriptionId?:number,externalRef?:string,notes?:string,error?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
customerId;
/** @type {string} */
email;
/** @type {number} */
skuId;
/** @type {string} */
skuName;
/** @type {SkuType} */
skuType;
/** @type {string} */
code;
/** @type {number} */
quantity;
/** @type {number} */
supportQuantity;
/** @type {number} */
total;
/** @type {boolean} */
isPlan;
/** @type {boolean} */
isRenewal;
/** @type {number} */
subscriptionDurationDays;
/** @type {?string} */
renewalDate;
/** @type {string} */
licenseRef;
/** @type {string} */
licenseName;
/** @type {string} */
licenseAddress;
/** @type {LicenseType} */
licenseType;
/** @type {string} */
expiryDate;
/** @type {LicenseKey} */
licenseKey;
/** @type {string} */
licenseKeyText;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {?string} */
cancelledDate;
/** @type {string} */
stripeSubscriptionId;
/** @type {?number} */
emailId;
/** @type {?number} */
emailRenewalId;
/** @type {?number} */
emailExpiredId;
/** @type {?number} */
renewalSubscriptionId;
/** @type {string} */
externalRef;
/** @type {string} */
notes;
/** @type {string} */
error;
}
export class OrderDetail {
/** @param {{id?:number,orderId?:number,skuId?:number,skuType?:SkuType,price?:number,description?:string,quantity?:number,total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
orderId;
/** @type {number} */
skuId;
/** @type {SkuType} */
skuType;
/** @type {number} */
price;
/** @type {string} */
description;
/** @type {number} */
quantity;
/** @type {number} */
total;
}
export class OrderAnalyticData {
/** @param {{productName?:string,subTotal?:number,couponId?:string,discount?:number,tax?:number,total?:number,paid?:boolean,createdDate?:string,modifiedDate?:string,modifiedBy?:string,cancelledDate?:string,cancelledReason?:string,orderDetails?:OrderDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
productName;
/** @type {number} */
subTotal;
/** @type {string} */
couponId;
/** @type {number} */
discount;
/** @type {number} */
tax;
/** @type {number} */
total;
/** @type {boolean} */
paid;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {string} */
modifiedBy;
/** @type {?string} */
cancelledDate;
/** @type {string} */
cancelledReason;
/** @type {OrderDetail[]} */
orderDetails;
}
export class SubscriptionsResponse {
/** @param {{section?:string,supportQuantity?:number,activeSku?:Sku,activeSubscription?:Subscription,inActiveSubscriptions?:Subscription[],purchasedOrder?:OrderAnalyticData,responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
section;
/** @type {number} */
supportQuantity;
/** @type {Sku} */
activeSku;
/** @type {Subscription} */
activeSubscription;
/** @type {Subscription[]} */
inActiveSubscriptions;
/** @type {OrderAnalyticData} */
purchasedOrder;
/** @type {ResponseStatus} */
responseStatus;
}
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
}
}
}