ServiceStack Home (Live)

<back to all web services

Buy

The following routes are available for this service:
All Verbs/buy/{Id}
GET/Buy/{Id}
All Verbs/buy/{Id}/{Quantity}
GET/Buy
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


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 QuoteResponse:
    sku_id: int = 0
    code: Optional[str] = None
    customer_id: Optional[int] = None
    modifying_existing_subscription: bool = False
    changing_subscriptions: bool = False
    switching_licensing_models: bool = False
    replaces_existing_quantity: bool = False
    existing_subscription_quantity: Optional[int] = None
    new_subscription_quantity: Optional[int] = None
    unused_amount: Optional[str] = None
    manual_prorating: bool = False
    unused_days: int = 0
    quantity: int = 0
    min_quantity: int = 0
    max_quantity: Optional[int] = None
    subtotal: Optional[str] = None
    discount_description: Optional[str] = None
    discount_received: Optional[str] = None
    discount: Optional[str] = None
    total: Optional[str] = None
    expiry_date: Optional[str] = None
    renewal_date: Optional[str] = None
    is_referrer: bool = False
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BuyResponse:
    coupon: Optional[str] = None
    renewal_ref: Optional[str] = None
    upgrade_ref: Optional[str] = None
    sku: Optional[Sku] = None
    quote: Optional[QuoteResponse] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Buy(IGet):
    id: Optional[str] = None
    coupon: Optional[str] = None
    quantity: Optional[int] = None
    renewal_ref: Optional[str] = None
    upgrade_ref: Optional[str] = None

Python Buy DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /buy/{Id} HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	coupon: String,
	quantity: 0,
	renewalRef: String,
	upgradeRef: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	coupon: String,
	renewalRef: String,
	upgradeRef: String,
	sku: 
	{
		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
	},
	quote: 
	{
		skuId: 0,
		code: String,
		customerId: 0,
		modifyingExistingSubscription: False,
		changingSubscriptions: False,
		switchingLicensingModels: False,
		replacesExistingQuantity: False,
		existingSubscriptionQuantity: 0,
		newSubscriptionQuantity: 0,
		unusedAmount: String,
		manualProrating: False,
		unusedDays: 0,
		quantity: 0,
		minQuantity: 0,
		maxQuantity: 0,
		subtotal: String,
		discountDescription: String,
		discountReceived: String,
		discount: String,
		total: String,
		expiryDate: String,
		renewalDate: String,
		isReferrer: False,
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}