ServiceStack Home (Live)

<back to all web services

Buy

The following routes are available for this service:
All Verbs/buy/{Id}
GET/Buy/{Id}
All Verbs/buy/{Id}/{Quantity}
GET/Buy
"use strict";
/** @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 QuoteResponse {
    /** @param {{skuId?:number,code?:string,customerId?:number,modifyingExistingSubscription?:boolean,changingSubscriptions?:boolean,switchingLicensingModels?:boolean,replacesExistingQuantity?:boolean,existingSubscriptionQuantity?:number,newSubscriptionQuantity?:number,unusedAmount?:string,manualProrating?:boolean,unusedDays?:number,quantity?:number,minQuantity?:number,maxQuantity?:number,subtotal?:string,discountDescription?:string,discountReceived?:string,discount?:string,total?:string,expiryDate?:string,renewalDate?:string,isReferrer?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    skuId;
    /** @type {string} */
    code;
    /** @type {?number} */
    customerId;
    /** @type {boolean} */
    modifyingExistingSubscription;
    /** @type {boolean} */
    changingSubscriptions;
    /** @type {boolean} */
    switchingLicensingModels;
    /** @type {boolean} */
    replacesExistingQuantity;
    /** @type {?number} */
    existingSubscriptionQuantity;
    /** @type {?number} */
    newSubscriptionQuantity;
    /** @type {string} */
    unusedAmount;
    /** @type {boolean} */
    manualProrating;
    /** @type {number} */
    unusedDays;
    /** @type {number} */
    quantity;
    /** @type {number} */
    minQuantity;
    /** @type {?number} */
    maxQuantity;
    /** @type {string} */
    subtotal;
    /** @type {string} */
    discountDescription;
    /** @type {string} */
    discountReceived;
    /** @type {string} */
    discount;
    /** @type {string} */
    total;
    /** @type {string} */
    expiryDate;
    /** @type {string} */
    renewalDate;
    /** @type {boolean} */
    isReferrer;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class BuyResponse {
    /** @param {{coupon?:string,renewalRef?:string,upgradeRef?:string,sku?:Sku,quote?:QuoteResponse,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    coupon;
    /** @type {string} */
    renewalRef;
    /** @type {string} */
    upgradeRef;
    /** @type {Sku} */
    sku;
    /** @type {QuoteResponse} */
    quote;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class Buy {
    /** @param {{id?:string,coupon?:string,quantity?:number,renewalRef?:string,upgradeRef?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    coupon;
    /** @type {?number} */
    quantity;
    /** @type {string} */
    renewalRef;
    /** @type {string} */
    upgradeRef;
}

JavaScript Buy DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /buy/{Id} HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Buy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Coupon>String</Coupon>
  <Id>String</Id>
  <Quantity>0</Quantity>
  <RenewalRef>String</RenewalRef>
  <UpgradeRef>String</UpgradeRef>
</Buy>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BuyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Coupon>String</Coupon>
  <Quote>
    <ChangingSubscriptions>false</ChangingSubscriptions>
    <Code>String</Code>
    <CustomerId>0</CustomerId>
    <Discount>String</Discount>
    <DiscountDescription>String</DiscountDescription>
    <DiscountReceived>String</DiscountReceived>
    <ExistingSubscriptionQuantity>0</ExistingSubscriptionQuantity>
    <ExpiryDate>String</ExpiryDate>
    <IsReferrer>false</IsReferrer>
    <ManualProrating>false</ManualProrating>
    <MaxQuantity>0</MaxQuantity>
    <MinQuantity>0</MinQuantity>
    <ModifyingExistingSubscription>false</ModifyingExistingSubscription>
    <NewSubscriptionQuantity>0</NewSubscriptionQuantity>
    <Quantity>0</Quantity>
    <RenewalDate>String</RenewalDate>
    <ReplacesExistingQuantity>false</ReplacesExistingQuantity>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <SkuId>0</SkuId>
    <Subtotal>String</Subtotal>
    <SwitchingLicensingModels>false</SwitchingLicensingModels>
    <Total>String</Total>
    <UnusedAmount>String</UnusedAmount>
    <UnusedDays>0</UnusedDays>
  </Quote>
  <RenewalRef>String</RenewalRef>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Sku>
    <Active>false</Active>
    <Code>String</Code>
    <CoresQty>0</CoresQty>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <DiscountLabelOff>String</DiscountLabelOff>
    <DiscountOff>0</DiscountOff>
    <ExpiryDurationDays>0</ExpiryDurationDays>
    <Feature>None</Feature>
    <Id>0</Id>
    <IsPlan>false</IsPlan>
    <IsRenewal>false</IsRenewal>
    <LicenseType>Free</LicenseType>
    <MaxQty>0</MaxQty>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <Name>String</Name>
    <Notes>String</Notes>
    <Plan>String</Plan>
    <Price>0</Price>
    <ProductId>0</ProductId>
    <SubscriptionDurationDays>0</SubscriptionDurationDays>
    <SupportQty>0</SupportQty>
    <TrialPeriodDays>0</TrialPeriodDays>
    <Type>Product</Type>
  </Sku>
  <UpgradeRef>String</UpgradeRef>
</BuyResponse>