ServiceStack Home (Live)

<back to all web services

Subscriptions

Requires Authentication
The following routes are available for this service:
All Verbs/account/subscription
GET/Subscriptions
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using MyApp.ServiceModel;

namespace MyApp.ServiceModel
{
    public partial class OrderAnalyticData
    {
        public virtual string ProductName { get; set; }
        public virtual int SubTotal { get; set; }
        public virtual string CouponId { get; set; }
        public virtual int Discount { get; set; }
        public virtual int Tax { get; set; }
        public virtual int Total { get; set; }
        public virtual bool Paid { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual string ModifiedBy { get; set; }
        public virtual DateTime? CancelledDate { get; set; }
        public virtual string CancelledReason { get; set; }
        public virtual List<OrderDetail> OrderDetails { get; set; }
    }

    public partial class OrderDetail
    {
        public virtual int Id { get; set; }
        public virtual int OrderId { get; set; }
        public virtual int SkuId { get; set; }
        public virtual SkuType SkuType { get; set; }
        public virtual int Price { get; set; }
        public virtual string Description { get; set; }
        public virtual int Quantity { get; set; }
        public virtual int Total { get; set; }
    }

    public partial class Sku
    {
        public virtual int Id { get; set; }
        public virtual int ProductId { get; set; }
        public virtual SkuType Type { get; set; }
        public virtual LicenseFeature Feature { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Notes { get; set; }
        [Ignore]
        public virtual int? MinQty { get; set; }

        public virtual int? MaxQty { get; set; }
        public virtual int Price { get; set; }
        public virtual string Plan { get; set; }
        public virtual int DiscountOff { get; set; }
        public virtual string DiscountLabelOff { get; set; }
        public virtual int ActualPrice { get; set; }
        public virtual bool IsPlan { get; set; }
        public virtual bool IsRenewal { get; set; }
        public virtual int? SubscriptionDurationDays { get; set; }
        public virtual int? ExpiryDurationDays { get; set; }
        public virtual int? TrialPeriodDays { get; set; }
        public virtual int SupportQty { get; set; }
        public virtual int? CoresQty { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual LicenseType LicenseType { get; set; }
        public virtual bool Active { get; set; }
    }

    public enum SkuType
    {
        Product,
        PerDev,
        PerCore,
        Site,
        Support,
        Training,
        Register,
        Payment,
    }

    public partial class Subscription
    {
        public virtual int Id { get; set; }
        public virtual int CustomerId { get; set; }
        public virtual string Email { get; set; }
        public virtual int SkuId { get; set; }
        public virtual string SkuName { get; set; }
        public virtual SkuType SkuType { get; set; }
        public virtual string Code { get; set; }
        public virtual int Quantity { get; set; }
        public virtual int SupportQuantity { get; set; }
        public virtual int Total { get; set; }
        public virtual bool IsPlan { get; set; }
        public virtual bool IsRenewal { get; set; }
        public virtual int SubscriptionDurationDays { get; set; }
        public virtual DateTime? RenewalDate { get; set; }
        public virtual string LicenseRef { get; set; }
        public virtual string LicenseName { get; set; }
        public virtual string LicenseAddress { get; set; }
        public virtual LicenseType LicenseType { get; set; }
        public virtual DateTime ExpiryDate { get; set; }
        public virtual LicenseKey LicenseKey { get; set; }
        public virtual string LicenseKeyText { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual DateTime? CancelledDate { get; set; }
        public virtual string StripeSubscriptionId { get; set; }
        public virtual int? EmailId { get; set; }
        public virtual int? EmailRenewalId { get; set; }
        public virtual int? EmailExpiredId { get; set; }
        public virtual int? RenewalSubscriptionId { get; set; }
        public virtual string ExternalRef { get; set; }
        public virtual string Notes { get; set; }
        public virtual string Error { get; set; }
    }

    public partial class Subscriptions
    {
        public virtual string Section { get; set; }
        public virtual bool Success { get; set; }
        public virtual bool Activated { get; set; }
        public virtual int? PurchasedOrderId { get; set; }
    }

    public partial class SubscriptionsResponse
    {
        public virtual string Section { get; set; }
        public virtual int SupportQuantity { get; set; }
        public virtual Sku ActiveSku { get; set; }
        public virtual Subscription ActiveSubscription { get; set; }
        public virtual List<Subscription> InActiveSubscriptions { get; set; }
        public virtual OrderAnalyticData PurchasedOrder { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack
{
    [Flags]
    public 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,
    }

    public partial class LicenseKey
    {
        public virtual string Ref { get; set; }
        public virtual string Name { get; set; }
        public virtual LicenseType Type { get; set; }
        public virtual long Meta { get; set; }
        public virtual string Hash { get; set; }
        public virtual string Halg { get; set; }
        public virtual DateTime Expiry { get; set; }
    }

    public enum LicenseType
    {
        Free,
        FreeIndividual,
        FreeOpenSource,
        Indie,
        Business,
        Enterprise,
        TextIndie,
        TextBusiness,
        OrmLiteIndie,
        OrmLiteBusiness,
        RedisIndie,
        RedisBusiness,
        AwsIndie,
        AwsBusiness,
        Trial,
        Site,
        TextSite,
        RedisSite,
        OrmLiteSite,
    }

}

C# 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>