Billhighway Cloud API

<back to all web services

SubscriptionCreateRq

import java.math.*
import java.util.*
import net.servicestack.client.*


open class SubscriptionCreateRq
{
    var NatID:Int? = null
    var GroupID:Int? = null
    var ClientGroupID:String? = null
    var UserType:String? = null
    var UserID:String? = null
    var FormData:SubscriberFormData? = null
    var SubscriptionInfo:SubscriptionInformation? = null
    var VerificationInfo:ClientVerification? = null
    var CcPaymentInfo:CcPaymentInformation? = null
    var AchPaymentInfo:AchPaymentInformation? = null
    var BillMeLater:BillMeLaterInformation? = null
    var Campaigns:ArrayList<CampaignInformation> = ArrayList<CampaignInformation>()
}

open class SubscriberFormData
{
    var FormTemplateID:Int? = null
    var SignupTypeID:Int? = null
    var FormFields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
}

open class SubscriberFormField
{
    var Name:String? = null
    var Value:String? = null
}

open class SubscriptionInformation
{
    var FrequencyID:Int? = null
    var SubscriptionInvoiceID:Int? = null
    var AutoRenew:Boolean? = null
    var HasAgreedToTerms:Boolean? = null
    var ClientSubscriberId:String? = null
    var RenewedMemberSubscriptionInvID:Int? = null
}

open class ClientVerification
{
    var Provider:String? = null
    var VerificationCode:String? = null
}

open class CcPaymentInformation
{
    var CardNumber:String? = null
    var Cvv:String? = null
    var ExpMonth:Int? = null
    var ExpYear:Int? = null
    var CardholderName:String? = null
    var Country:String? = null
    var BillingAddress:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var City:String? = null
    var StateProvince:String? = null
    var PostalCode:String? = null
}

open class AchPaymentInformation
{
    var AccountHolderName:String? = null
    var CheckNumber:String? = null
    var RoutingNumber:String? = null
    var AccountNumber:String? = null
    var AccountType:String? = null
}

open class BillMeLaterInformation
{
    var IsBillMeLaterPayment:Boolean? = null
    var IsBillMeLaterSubscription:Boolean? = null
    var MemberSubscriptionInvId:Int? = null
    var Campaigns:ArrayList<CampaignInformation> = ArrayList<CampaignInformation>()
}

open class CampaignInformation
{
    var CampaignId:Int? = null
    var CampaignName:String? = null
    var Amount:BigDecimal? = null
    var ChapPayID:String? = null
}

open class SubscriptionCreateRs
{
    var IsSuccess:Boolean? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var BillhighwayUserId:Int? = null
    var ConfirmationNumber:String? = null
    var PaymentConfirmationNumber:Long? = null
    var SubscriptionConfirmationNumber:Long? = null
    var ErrorCode:String? = null
    var Message:String? = null
    var FriendlyMessage:String? = null
}

Kotlin SubscriptionCreateRq DTOs

POST /signup/api/nat/{natID}/group/{groupID}/subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NatID: 0,
	GroupID: 0,
	ClientGroupID: String,
	UserType: String,
	UserID: String,
	FormData: 
	{
		FormTemplateID: 0,
		SignupTypeID: 0,
		FormFields: 
		[
			{
				FormTemplateFieldID: 0,
				Name: String,
				Value: String
			}
		]
	},
	SubscriptionInfo: 
	{
		FrequencyID: 0,
		SubscriptionInvoiceID: 0,
		AutoRenew: False,
		HasAgreedToTerms: False,
		ClientSubscriberId: String,
		RenewedMemberSubscriptionInvID: 0
	},
	VerificationInfo: 
	{
		Provider: String,
		VerificationCode: String
	},
	CcPaymentInfo: 
	{
		CardNumber: String,
		Cvv: String,
		ExpMonth: 0,
		ExpYear: 0,
		CardholderName: String,
		Country: String,
		BillingAddress: String,
		Address1: String,
		Address2: String,
		City: String,
		StateProvince: String,
		PostalCode: String
	},
	AchPaymentInfo: 
	{
		AccountHolderName: String,
		CheckNumber: String,
		RoutingNumber: String,
		AccountNumber: String,
		AccountType: String
	},
	BillMeLater: 
	{
		IsBillMeLaterPayment: False,
		IsBillMeLaterSubscription: False,
		MemberSubscriptionInvId: 0,
		Campaigns: 
		[
			{
				CampaignId: 0,
				CampaignName: String,
				Amount: 0,
				ChapPayID: String
			}
		]
	},
	Campaigns: 
	[
		{
			CampaignId: 0,
			CampaignName: String,
			Amount: 0,
			ChapPayID: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSuccess: False,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	BillhighwayUserId: 0,
	ConfirmationNumber: String,
	PaymentConfirmationNumber: 0,
	SubscriptionConfirmationNumber: 0,
	ErrorCode: String,
	Message: String,
	FriendlyMessage: String
}