Billhighway Cloud API

<back to all web services

SubscriptionFormAccessRq

The following routes are available for this service:
POST/signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/form/access/link
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 SubscriptionFormAccessRq:
    nat_i_d: Optional[int] = None
    group_i_d: Optional[int] = None
    user_i_d: Optional[int] = None
    user_type: Optional[str] = None
    admin_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    subscription_lineage_i_d: Optional[int] = None
    client_subscriber_id: Optional[str] = None
    member_subscription_inv_id: Optional[int] = None
    is_print_view: Optional[bool] = None
    is_bill_me_later_subscription: Optional[bool] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None
    is_renewal: Optional[bool] = None
    client_subscription_type_i_d: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkResponse:
    rel: Optional[str] = None
    uri: Optional[str] = None

Python SubscriptionFormAccessRq 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 /signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/form/access/link HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NatID: 0,
	GroupID: 0,
	UserID: 0,
	UserType: String,
	AdminID: 0,
	SubscriptionInvoiceID: 0,
	SubscriptionLineageID: 0,
	ClientSubscriberId: String,
	MemberSubscriptionInvId: 0,
	IsPrintView: False,
	IsBillMeLaterSubscription: False,
	RenewedMemberSubscriptionInvID: 0,
	IsRenewal: False,
	ClientSubscriptionTypeID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rel: String,
	Uri: String
}