| Required role: | Admin |
| All Verbs | /query/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 QueryBase:
skip: Optional[int] = None
take: Optional[int] = None
order_by: Optional[str] = None
order_by_desc: Optional[str] = None
include: Optional[str] = None
fields: Optional[str] = None
meta: Optional[Dict[str, str]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
@staticmethod
def response_type(): return QueryResponse[T]
class SkuType(str, Enum):
PRODUCT = 'Product'
PER_DEV = 'PerDev'
PER_CORE = 'PerCore'
SITE = 'Site'
SUPPORT = 'Support'
TRAINING = 'Training'
REGISTER = 'Register'
PAYMENT = 'Payment'
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 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
# @ValidateRequest(Validator="IsAdmin")
# @AutoQueryViewer(DefaultSearchField="Email", DefaultSearchType="Contains", IconUrl="material-icons:person_outline", Title="Subscriptions")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuerySubscriptions(QueryDb[Subscription]):
pass
@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 Order(IAddress):
id: int = 0
customer_id: int = 0
product_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
company: Optional[str] = None
phone_number: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_city: Optional[str] = None
address_zip: Optional[str] = None
address_state: Optional[str] = None
address_country: Optional[str] = None
agree_terms: bool = False
notes: Optional[str] = None
last4: Optional[str] = None
sub_total: int = 0
coupon_id: Optional[str] = None
discount: int = 0
tax: int = 0
total: int = 0
item_quantity: int = 0
authorized_quantity: Optional[int] = None
subscription_id: Optional[int] = None
license_ref: Optional[str] = None
payment_id: Optional[int] = None
email_id: Optional[int] = None
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
ip_address: Optional[str] = None
order_details: Optional[List[OrderDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer(IAddress):
id: int = 0
email: Optional[str] = None
display_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
company: Optional[str] = None
phone_number: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_city: Optional[str] = None
address_zip: Optional[str] = None
address_state: Optional[str] = None
address_country: Optional[str] = None
stripe_customer_id: Optional[str] = None
stripe_coupon_id: Optional[str] = None
plan: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
is_referrer: bool = False
orders: Optional[List[Order]] = None
subscriptions: Optional[List[Subscription]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: int = 0
total: int = 0
results: List[Customer] = field(default_factory=list)
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
Python QuerySubscriptions DTOs
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 /query/subscriptions HTTP/1.1
Host: account.servicestack.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
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
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}