BackofficeApi

UpdateSubscriptionPlanRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

The following routes are available for this service:
PUT	/subscription/update_plan

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 UpdateSubscriptionPlanRequest 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.

PUT /subscription/update_plan HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateSubscriptionPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <CanBeSelectedByClient>false</CanBeSelectedByClient>
  <Id>0</Id>
  <SubscriptionPlanDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:FreeOnClaim>
      <d2p1:Months>0</d2p1:Months>
    </d2p1:FreeOnClaim>
    <d2p1:FreeUntil>
      <d2p1:StopAt>0001-01-01T00:00:00</d2p1:StopAt>
    </d2p1:FreeUntil>
    <d2p1:Invoice>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:Period>Monthly</d2p1:Period>
    </d2p1:Invoice>
    <d2p1:MonthlyStripe>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:FreeStartUpMonths>0</d2p1:FreeStartUpMonths>
    </d2p1:MonthlyStripe>
  </SubscriptionPlanDetails>
</UpdateSubscriptionPlanRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateSubscriptionPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Success>false</Success>
</UpdateSubscriptionPlanResponse>