Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription
import java.math.*
import java.util.*
import net.servicestack.client.*


open class MemberSubscriptionCollection
{
    var MemberSubscriptions:ArrayList<MemberSubscription> = ArrayList<MemberSubscription>()
}

open class MemberSubscription
{
    var UniqueId:String? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserID:String? = null
    var ClientCompanyID:String? = null
    var ClientOrderID:Long? = null
    var ClientMemberSubscriberID:Long? = null
    var ClientSubscriptionTemplate:String? = null
    var SubscriptionID:Long? = null
    var StartDate:Date? = null
    var EndDate:Date? = null
}

open class MemberSubscriptionReplyCollection : IHaveErrorField
{
    var MemberSubscriptionReply:ArrayList<MemberSubscriptionReply> = ArrayList<MemberSubscriptionReply>()
    var IsError:Boolean? = null
}

open class MemberSubscriptionReply
{
    var UniqueId:String? = null
    var ClientId:Int? = null
    var MemberSubscriptionInvoiceId:Int? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
}

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