| All Verbs | /account/subscription | ||
|---|---|---|---|
| GET | /Subscriptions |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscriptions:
section: Optional[str] = None
success: bool = False
activated: bool = False
purchased_order_id: Optional[int] = None
class SkuType(str, Enum):
PRODUCT = 'Product'
PER_DEV = 'PerDev'
PER_CORE = 'PerCore'
SITE = 'Site'
SUPPORT = 'Support'
TRAINING = 'Training'
REGISTER = 'Register'
PAYMENT = 'Payment'
# @Flags()
class LicenseFeature(IntEnum):
NONE = 0
FREE = 0
PREMIUM = 1
TEXT = 2
CLIENT = 4
COMMON = 8
REDIS = 16
REDIS_SKU = 18
ORM_LITE = 32
ORM_LITE_SKU = 34
SERVICE_STACK = 64
SERVER = 128
RAZOR = 256
ADMIN = 512
AWS = 1024
AWS_SKU = 1026
ALL = 2047
class LicenseType(str, Enum):
FREE = 'Free'
FREE_INDIVIDUAL = 'FreeIndividual'
FREE_OPEN_SOURCE = 'FreeOpenSource'
INDIE = 'Indie'
BUSINESS = 'Business'
ENTERPRISE = 'Enterprise'
TEXT_INDIE = 'TextIndie'
TEXT_BUSINESS = 'TextBusiness'
ORM_LITE_INDIE = 'OrmLiteIndie'
ORM_LITE_BUSINESS = 'OrmLiteBusiness'
REDIS_INDIE = 'RedisIndie'
REDIS_BUSINESS = 'RedisBusiness'
AWS_INDIE = 'AwsIndie'
AWS_BUSINESS = 'AwsBusiness'
TRIAL = 'Trial'
SITE = 'Site'
TEXT_SITE = 'TextSite'
REDIS_SITE = 'RedisSite'
ORM_LITE_SITE = 'OrmLiteSite'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sku:
id: int = 0
product_id: int = 0
type: Optional[SkuType] = None
feature: Optional[LicenseFeature] = None
code: Optional[str] = None
name: Optional[str] = None
notes: Optional[str] = None
# @Ignore()
min_qty: Optional[int] = None
max_qty: Optional[int] = None
price: int = 0
plan: Optional[str] = None
discount_off: int = 0
discount_label_off: Optional[str] = None
actual_price: int = 0
is_plan: bool = False
is_renewal: bool = False
subscription_duration_days: Optional[int] = None
expiry_duration_days: Optional[int] = None
trial_period_days: Optional[int] = None
support_qty: int = 0
cores_qty: Optional[int] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
license_type: Optional[LicenseType] = None
active: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseKey:
ref: Optional[str] = None
name: Optional[str] = None
type: Optional[LicenseType] = None
meta: int = 0
hash: Optional[str] = None
halg: Optional[str] = None
expiry: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscription:
id: int = 0
customer_id: int = 0
email: Optional[str] = None
sku_id: int = 0
sku_name: Optional[str] = None
sku_type: Optional[SkuType] = None
code: Optional[str] = None
quantity: int = 0
support_quantity: int = 0
total: int = 0
is_plan: bool = False
is_renewal: bool = False
subscription_duration_days: int = 0
renewal_date: Optional[datetime.datetime] = None
license_ref: Optional[str] = None
license_name: Optional[str] = None
license_address: Optional[str] = None
license_type: Optional[LicenseType] = None
expiry_date: datetime.datetime = datetime.datetime(1, 1, 1)
license_key: Optional[LicenseKey] = None
license_key_text: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
cancelled_date: Optional[datetime.datetime] = None
stripe_subscription_id: Optional[str] = None
email_id: Optional[int] = None
email_renewal_id: Optional[int] = None
email_expired_id: Optional[int] = None
renewal_subscription_id: Optional[int] = None
external_ref: Optional[str] = None
notes: Optional[str] = None
error: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderDetail:
id: int = 0
order_id: int = 0
sku_id: int = 0
sku_type: Optional[SkuType] = None
price: int = 0
description: Optional[str] = None
quantity: int = 0
total: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderAnalyticData:
product_name: Optional[str] = None
sub_total: int = 0
coupon_id: Optional[str] = None
discount: int = 0
tax: int = 0
total: int = 0
paid: bool = False
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_by: Optional[str] = None
cancelled_date: Optional[datetime.datetime] = None
cancelled_reason: Optional[str] = None
order_details: Optional[List[OrderDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionsResponse:
section: Optional[str] = None
support_quantity: int = 0
active_sku: Optional[Sku] = None
active_subscription: Optional[Subscription] = None
in_active_subscriptions: Optional[List[Subscription]] = None
purchased_order: Optional[OrderAnalyticData] = None
response_status: Optional[ResponseStatus] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
section: String,
success: False,
activated: False,
purchasedOrderId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
section: String,
supportQuantity: 0,
activeSku:
{
id: 0,
productId: 0,
type: Product,
feature: 0,
code: String,
name: String,
notes: String,
maxQty: 0,
price: 0,
plan: String,
discountOff: 0,
discountLabelOff: String,
actualPrice: 0,
isPlan: False,
isRenewal: False,
subscriptionDurationDays: 0,
expiryDurationDays: 0,
trialPeriodDays: 0,
supportQty: 0,
coresQty: 0,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
licenseType: Free,
active: False
},
activeSubscription:
{
id: 0,
customerId: 0,
email: String,
skuId: 0,
skuName: String,
skuType: Product,
code: String,
quantity: 0,
supportQuantity: 0,
total: 0,
isPlan: False,
isRenewal: False,
subscriptionDurationDays: 0,
renewalDate: 0001-01-01,
licenseRef: String,
licenseName: String,
licenseAddress: String,
licenseType: Free,
expiryDate: 0001-01-01,
licenseKey:
{
ref: String,
name: String,
type: Free,
meta: 0,
hash: String,
halg: String,
expiry: 0001-01-01
},
licenseKeyText: String,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
cancelledDate: 0001-01-01,
stripeSubscriptionId: String,
emailId: 0,
emailRenewalId: 0,
emailExpiredId: 0,
renewalSubscriptionId: 0,
externalRef: String,
notes: String,
error: String
},
inActiveSubscriptions:
[
{
id: 0,
customerId: 0,
email: String,
skuId: 0,
skuName: String,
skuType: Product,
code: String,
quantity: 0,
supportQuantity: 0,
total: 0,
isPlan: False,
isRenewal: False,
subscriptionDurationDays: 0,
renewalDate: 0001-01-01,
licenseRef: String,
licenseName: String,
licenseAddress: String,
licenseType: Free,
expiryDate: 0001-01-01,
licenseKey:
{
ref: String,
name: String,
type: Free,
meta: 0,
hash: String,
halg: String,
expiry: 0001-01-01
},
licenseKeyText: String,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
cancelledDate: 0001-01-01,
stripeSubscriptionId: String,
emailId: 0,
emailRenewalId: 0,
emailExpiredId: 0,
renewalSubscriptionId: 0,
externalRef: String,
notes: String,
error: String
}
],
purchasedOrder:
{
productName: String,
subTotal: 0,
couponId: String,
discount: 0,
tax: 0,
total: 0,
paid: False,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
modifiedBy: String,
cancelledDate: 0001-01-01,
cancelledReason: String,
orderDetails:
[
{
id: 0,
orderId: 0,
skuId: 0,
skuType: Product,
price: 0,
description: String,
quantity: 0,
total: 0
}
]
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}