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
namespace MyApp.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Subscriptions() = 
        member val Section:String = null with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Activated:Boolean = new Boolean() with get,set
        member val PurchasedOrderId:Nullable<Int32> = new Nullable<Int32>() with get,set

    type SkuType =
        | Product = 0
        | PerDev = 1
        | PerCore = 2
        | Site = 3
        | Support = 4
        | Training = 5
        | Register = 6
        | Payment = 7

    [<Flags>]
    type 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

    type LicenseType =
        | Free = 0
        | FreeIndividual = 1
        | FreeOpenSource = 2
        | Indie = 3
        | Business = 4
        | Enterprise = 5
        | TextIndie = 6
        | TextBusiness = 7
        | OrmLiteIndie = 8
        | OrmLiteBusiness = 9
        | RedisIndie = 10
        | RedisBusiness = 11
        | AwsIndie = 12
        | AwsBusiness = 13
        | Trial = 14
        | Site = 15
        | TextSite = 16
        | RedisSite = 17
        | OrmLiteSite = 18

    [<AllowNullLiteral>]
    type Sku() = 
        member val Id:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val Type:SkuType = new SkuType() with get,set
        member val Feature:LicenseFeature = new LicenseFeature() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Notes:String = null with get,set
        [<Ignore>]
        member val MinQty:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val MaxQty:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Price:Int32 = new Int32() with get,set
        member val Plan:String = null with get,set
        member val DiscountOff:Int32 = new Int32() with get,set
        member val DiscountLabelOff:String = null with get,set
        member val ActualPrice:Int32 = new Int32() with get,set
        member val IsPlan:Boolean = new Boolean() with get,set
        member val IsRenewal:Boolean = new Boolean() with get,set
        member val SubscriptionDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ExpiryDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TrialPeriodDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SupportQty:Int32 = new Int32() with get,set
        member val CoresQty:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val LicenseType:LicenseType = new LicenseType() with get,set
        member val Active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LicenseKey() = 
        member val Ref:String = null with get,set
        member val Name:String = null with get,set
        member val Type:LicenseType = new LicenseType() with get,set
        member val Meta:Int64 = new Int64() with get,set
        member val Hash:String = null with get,set
        member val Halg:String = null with get,set
        member val Expiry:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Subscription() = 
        member val Id:Int32 = new Int32() with get,set
        member val CustomerId:Int32 = new Int32() with get,set
        member val Email:String = null with get,set
        member val SkuId:Int32 = new Int32() with get,set
        member val SkuName:String = null with get,set
        member val SkuType:SkuType = new SkuType() with get,set
        member val Code:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val SupportQuantity:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val IsPlan:Boolean = new Boolean() with get,set
        member val IsRenewal:Boolean = new Boolean() with get,set
        member val SubscriptionDurationDays:Int32 = new Int32() with get,set
        member val RenewalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LicenseRef:String = null with get,set
        member val LicenseName:String = null with get,set
        member val LicenseAddress:String = null with get,set
        member val LicenseType:LicenseType = new LicenseType() with get,set
        member val ExpiryDate:DateTime = new DateTime() with get,set
        member val LicenseKey:LicenseKey = null with get,set
        member val LicenseKeyText:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StripeSubscriptionId:String = null with get,set
        member val EmailId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EmailRenewalId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EmailExpiredId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RenewalSubscriptionId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ExternalRef:String = null with get,set
        member val Notes:String = null with get,set
        member val Error:String = null with get,set

    [<AllowNullLiteral>]
    type OrderDetail() = 
        member val Id:Int32 = new Int32() with get,set
        member val OrderId:Int32 = new Int32() with get,set
        member val SkuId:Int32 = new Int32() with get,set
        member val SkuType:SkuType = new SkuType() with get,set
        member val Price:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type OrderAnalyticData() = 
        member val ProductName:String = null with get,set
        member val SubTotal:Int32 = new Int32() with get,set
        member val CouponId:String = null with get,set
        member val Discount:Int32 = new Int32() with get,set
        member val Tax:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val Paid:Boolean = new Boolean() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:DateTime = new DateTime() with get,set
        member val ModifiedBy:String = null with get,set
        member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledReason:String = null with get,set
        member val OrderDetails:ResizeArray<OrderDetail> = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionsResponse() = 
        member val Section:String = null with get,set
        member val SupportQuantity:Int32 = new Int32() with get,set
        member val ActiveSku:Sku = null with get,set
        member val ActiveSubscription:Subscription = null with get,set
        member val InActiveSubscriptions:ResizeArray<Subscription> = null with get,set
        member val PurchasedOrder:OrderAnalyticData = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

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