ServiceStack Home (Live)

<back to all web services

Support

Requires Authentication
The following routes are available for this service:
All Verbs/account/support
All Verbs/Support
"use strict";
export class Support {
    /** @param {{section?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    section;
}
/** @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 {'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 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 SupportContact {
    /** @param {{id?:number,customerId?:number,name?:string,email?:string,gitHub?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    customerId;
    /** @type {string} */
    name;
    /** @type {string} */
    email;
    /** @type {string} */
    gitHub;
}
export class SupportResponse {
    /** @param {{activeSubscription?:Subscription,section?:string,maxQuantity?:number,supportQuantity?:number,skuType?:string,supportContacts?:SupportContact[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Subscription} */
    activeSubscription;
    /** @type {string} */
    section;
    /** @type {number} */
    maxQuantity;
    /** @type {number} */
    supportQuantity;
    /** @type {string} */
    skuType;
    /** @type {SupportContact[]} */
    supportContacts;
    /** @type {ResponseStatus} */
    responseStatus;
}

JavaScript Support 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 /account/support HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Support xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Section>String</Section>
</Support>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SupportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <ActiveSubscription>
    <CancelledDate>0001-01-01T00:00:00</CancelledDate>
    <Code>String</Code>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CustomerId>0</CustomerId>
    <Email>String</Email>
    <EmailExpiredId>0</EmailExpiredId>
    <EmailId>0</EmailId>
    <EmailRenewalId>0</EmailRenewalId>
    <Error>String</Error>
    <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
    <ExternalRef>String</ExternalRef>
    <Id>0</Id>
    <IsPlan>false</IsPlan>
    <IsRenewal>false</IsRenewal>
    <LicenseAddress>String</LicenseAddress>
    <LicenseKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack">
      <d3p1:Expiry>0001-01-01T00:00:00</d3p1:Expiry>
      <d3p1:Halg>String</d3p1:Halg>
      <d3p1:Hash>String</d3p1:Hash>
      <d3p1:Meta>0</d3p1:Meta>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:Ref>String</d3p1:Ref>
      <d3p1:Type>Free</d3p1:Type>
    </LicenseKey>
    <LicenseKeyText>String</LicenseKeyText>
    <LicenseName>String</LicenseName>
    <LicenseRef>String</LicenseRef>
    <LicenseType>Free</LicenseType>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <Notes>String</Notes>
    <Quantity>0</Quantity>
    <RenewalDate>0001-01-01T00:00:00</RenewalDate>
    <RenewalSubscriptionId>0</RenewalSubscriptionId>
    <SkuId>0</SkuId>
    <SkuName>String</SkuName>
    <SkuType>Product</SkuType>
    <StripeSubscriptionId>String</StripeSubscriptionId>
    <SubscriptionDurationDays>0</SubscriptionDurationDays>
    <SupportQuantity>0</SupportQuantity>
    <Total>0</Total>
  </ActiveSubscription>
  <MaxQuantity>0</MaxQuantity>
  <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>
  <Section>String</Section>
  <SkuType>String</SkuType>
  <SupportContacts>
    <SupportContact>
      <CustomerId>0</CustomerId>
      <Email>String</Email>
      <GitHub>String</GitHub>
      <Id>0</Id>
      <Name>String</Name>
    </SupportContact>
  </SupportContacts>
  <SupportQuantity>0</SupportQuantity>
</SupportResponse>