Billhighway Cloud API

SubscriptionCreateRq

The following routes are available for this service:
POST	/signup/api/nat/{natID}/group/{groupID}/subscription
POST	/signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/subscription

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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}/subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubscriptionCreateRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Request">
  <AchPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AccountHolderName>String</d2p1:AccountHolderName>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:CheckNumber>String</d2p1:CheckNumber>
    <d2p1:RoutingNumber>String</d2p1:RoutingNumber>
  </AchPaymentInfo>
  <BillMeLater xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Campaigns>
      <d2p1:CampaignInformation>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:CampaignId>0</d2p1:CampaignId>
        <d2p1:CampaignName>String</d2p1:CampaignName>
        <d2p1:ChapPayID>String</d2p1:ChapPayID>
      </d2p1:CampaignInformation>
    </d2p1:Campaigns>
    <d2p1:IsBillMeLaterPayment>false</d2p1:IsBillMeLaterPayment>
    <d2p1:IsBillMeLaterSubscription>false</d2p1:IsBillMeLaterSubscription>
    <d2p1:MemberSubscriptionInvId>0</d2p1:MemberSubscriptionInvId>
  </BillMeLater>
  <Campaigns xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:CampaignInformation>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:CampaignId>0</d2p1:CampaignId>
      <d2p1:CampaignName>String</d2p1:CampaignName>
      <d2p1:ChapPayID>String</d2p1:ChapPayID>
    </d2p1:CampaignInformation>
  </Campaigns>
  <CcPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BillingAddress>String</d2p1:BillingAddress>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardholderName>String</d2p1:CardholderName>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Cvv>String</d2p1:Cvv>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateProvince>String</d2p1:StateProvince>
  </CcPaymentInfo>
  <ClientGroupID>String</ClientGroupID>
  <FormData xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:FormFields>
      <d2p1:SubscriberFormField>
        <d2p1:_x003C_FormTemplateFieldID_x003E_k__BackingField>0</d2p1:_x003C_FormTemplateFieldID_x003E_k__BackingField>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
      </d2p1:SubscriberFormField>
    </d2p1:FormFields>
    <d2p1:FormTemplateID>0</d2p1:FormTemplateID>
    <d2p1:SignupTypeID>0</d2p1:SignupTypeID>
  </FormData>
  <GroupID>0</GroupID>
  <NatID>0</NatID>
  <SubscriptionInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AutoRenew>false</d2p1:AutoRenew>
    <d2p1:ClientSubscriberId>String</d2p1:ClientSubscriberId>
    <d2p1:FrequencyID>0</d2p1:FrequencyID>
    <d2p1:HasAgreedToTerms>false</d2p1:HasAgreedToTerms>
    <d2p1:RenewedMemberSubscriptionInvID>0</d2p1:RenewedMemberSubscriptionInvID>
    <d2p1:SubscriptionInvoiceID>0</d2p1:SubscriptionInvoiceID>
  </SubscriptionInfo>
  <UserID>String</UserID>
  <UserType>String</UserType>
  <VerificationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Provider>String</d2p1:Provider>
    <d2p1:VerificationCode>String</d2p1:VerificationCode>
  </VerificationInfo>
</SubscriptionCreateRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubscriptionCreateRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Response">
  <BillhighwayUserId>0</BillhighwayUserId>
  <ClientId>0</ClientId>
  <ConfirmationNumber>String</ConfirmationNumber>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>String</ErrorCode>
  <FriendlyMessage>String</FriendlyMessage>
  <IsSuccess>false</IsSuccess>
  <Message>String</Message>
  <PaymentConfirmationNumber>0</PaymentConfirmationNumber>
  <SubscriptionConfirmationNumber>0</SubscriptionConfirmationNumber>
  <UniqueId>String</UniqueId>
</SubscriptionCreateRs>