BackofficeApi

GetSubscriptionPlansRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

The following routes are available for this service:
GET	/subscription/get_plans

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

# module BackofficeApi


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanDetailsFreeUntil:
    stop_at: datetime.datetime = datetime.datetime(1, 1, 1)


class Period(str, Enum):
    MONTHLY = 'Monthly'
    YEARLY = 'Yearly'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanDetailsInvoice:
    period: Optional[Period] = None
    amount: float = 0.0
    currency: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanDetailsMonthlyStripe:
    amount: float = 0.0
    currency: Optional[str] = None
    free_start_up_months: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanDetailsFreeOnClaim:
    months: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionPlanDetailsUnion:
    free_until: Optional[PlanDetailsFreeUntil] = None
    invoice: Optional[PlanDetailsInvoice] = None
    monthly_stripe: Optional[PlanDetailsMonthlyStripe] = None
    free_on_claim: Optional[PlanDetailsFreeOnClaim] = None

Python GetSubscriptionPlansRequest 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.

GET /subscription/get_plans HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscriptionPlans: 
	[
		{
			id: 0,
			canBeSelectedByClient: False,
			slug: String,
			subscriptionPlanDetails: 
			{
				freeUntil: 
				{
					stopAt: 0001-01-01
				},
				invoice: 
				{
					period: Monthly,
					amount: 0,
					currency: String
				},
				monthlyStripe: 
				{
					amount: 0,
					currency: String,
					freeStartUpMonths: 0
				},
				freeOnClaim: 
				{
					months: 0
				}
			}
		}
	]
}