BackofficeApi

GetSubscriptionRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

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

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 SubscriptionDetailsFreeUntil:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionDetailsInvoice:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionDetailsStripe:
    stripe_x: Optional[str] = None
    card_expires_at_month: int = 0
    card_expires_at_year: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionDetailsFreeOnClaim:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionDetailsUnion:
    free_until: Optional[SubscriptionDetailsFreeUntil] = None
    invoice: Optional[SubscriptionDetailsInvoice] = None
    stripe: Optional[SubscriptionDetailsStripe] = None
    free_on_claim: Optional[SubscriptionDetailsFreeOnClaim] = None

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

GET /subscription/get HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: application/xml

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

<GetSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Subscriptions>
    <SubscriptionDto>
      <BusinessId>0</BusinessId>
      <Id>0</Id>
      <SubscriptionDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:FreeOnClaim />
        <d4p1:FreeUntil />
        <d4p1:Invoice />
        <d4p1:Stripe>
          <d4p1:CardExpiresAtMonth>0</d4p1:CardExpiresAtMonth>
          <d4p1:CardExpiresAtYear>0</d4p1:CardExpiresAtYear>
          <d4p1:StripeX>String</d4p1:StripeX>
        </d4p1:Stripe>
      </SubscriptionDetails>
      <SubscriptionPlanId>0</SubscriptionPlanId>
    </SubscriptionDto>
  </Subscriptions>
</GetSubscriptionResponse>