Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription
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 MemberSubscription:
    unique_id: Optional[str] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_i_d: Optional[str] = None
    client_company_i_d: Optional[str] = None
    client_order_i_d: Optional[int] = None
    client_member_subscriber_i_d: Optional[int] = None
    client_subscription_template: Optional[str] = None
    subscription_i_d: Optional[int] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberSubscriptionCollection:
    member_subscriptions: Optional[List[MemberSubscription]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberSubscriptionReply:
    unique_id: Optional[str] = None
    client_id: Optional[int] = None
    member_subscription_invoice_id: Optional[int] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberSubscriptionReplyCollection(IHaveErrorField):
    member_subscription_reply: Optional[List[MemberSubscriptionReply]] = None
    is_error: Optional[bool] = None

Python MemberSubscriptionCollection 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 /subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MemberSubscriptions: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserID: String,
			ClientCompanyID: String,
			ClientOrderID: 0,
			ClientMemberSubscriberID: 0,
			ClientSubscriptionTemplate: String,
			SubscriptionID: 0,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberSubscriptionReply: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			MemberSubscriptionInvoiceId: 0,
			ErrorCode: 0,
			ErrorMessage: String
		}
	],
	IsError: False
}