Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription

export class MemberSubscription
{
    public UniqueId?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserID?: string;
    public ClientCompanyID?: string;
    public ClientOrderID?: number;
    public ClientMemberSubscriberID?: number;
    public ClientSubscriptionTemplate?: string;
    public SubscriptionID?: number;
    public StartDate?: string;
    public EndDate?: string;

    public constructor(init?: Partial<MemberSubscription>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionCollection
{
    public MemberSubscriptions?: MemberSubscription[];

    public constructor(init?: Partial<MemberSubscriptionCollection>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionReply
{
    public UniqueId?: string;
    public ClientId?: number;
    public MemberSubscriptionInvoiceId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;

    public constructor(init?: Partial<MemberSubscriptionReply>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionReplyCollection implements IHaveErrorField
{
    public MemberSubscriptionReply?: MemberSubscriptionReply[];
    public IsError?: boolean;

    public constructor(init?: Partial<MemberSubscriptionReplyCollection>) { (Object as any).assign(this, init); }
}

TypeScript 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
}