ServiceStack Home (Live)

Subscriptions

The following routes are available for this service:
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); }
}

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

<Subscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Activated>false</Activated>
  <PurchasedOrderId>0</PurchasedOrderId>
  <Section>String</Section>
  <Success>false</Success>
</Subscriptions>

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

<SubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <ActiveSku>
    <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>
  </ActiveSku>
  <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>
  <InActiveSubscriptions>
    <Subscription>
      <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:d4p1="http://schemas.datacontract.org/2004/07/ServiceStack">
        <d4p1:Expiry>0001-01-01T00:00:00</d4p1:Expiry>
        <d4p1:Halg>String</d4p1:Halg>
        <d4p1:Hash>String</d4p1:Hash>
        <d4p1:Meta>0</d4p1:Meta>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Ref>String</d4p1:Ref>
        <d4p1:Type>Free</d4p1: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>
    </Subscription>
  </InActiveSubscriptions>
  <PurchasedOrder>
    <CancelledDate>0001-01-01T00:00:00</CancelledDate>
    <CancelledReason>String</CancelledReason>
    <CouponId>String</CouponId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Discount>0</Discount>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <OrderDetails>
      <OrderDetail>
        <Description>String</Description>
        <Id>0</Id>
        <OrderId>0</OrderId>
        <Price>0</Price>
        <Quantity>0</Quantity>
        <SkuId>0</SkuId>
        <SkuType>Product</SkuType>
        <Total>0</Total>
      </OrderDetail>
    </OrderDetails>
    <Paid>false</Paid>
    <ProductName>String</ProductName>
    <SubTotal>0</SubTotal>
    <Tax>0</Tax>
    <Total>0</Total>
  </PurchasedOrder>
  <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>
  <SupportQuantity>0</SupportQuantity>
</SubscriptionsResponse>