Billhighway Cloud API

<back to all web services

BillMeLaterSubscription

BillMeLaterSubscription Parameters:
NameParameterData TypeRequiredDescription
HeaderqueryApiClientHeaderNo
SubscriptionInfoquerySubscriptionParametersNo
CampaignInfoqueryList<CampaignInformation>No
ApiClientHeader Parameters:
NameParameterData TypeRequiredDescription
ClientIdformintNo
ReferrerformstringNo
IpAddressformstringNo
LoggedInUserIdformintNo
GroupIdformintNo
TaskformstringNo
MachineformstringNo
LocationformstringNo
CreatedByformintNo
CampaignIdformintNo
SubscriptionParameters Parameters:
NameParameterData TypeRequiredDescription
FormTemplateIDformintNo
SubscriptionInvoiceIDformintNo
ClientSubscriberIdformstringNo
SignupTypeIDformintNo
FrequencyIDformintNo
AutoRenewformboolNo
CompanyIDformlongNo
UserIDformintNo
ChapMemPayIDformlongNo
MemberSubscriptionInvIDformlongNo
FieldsformList<SubscriberFormField>No
CreatedByformintNo
UpdatedByformintNo
AptifyUpdateTypeformintNo
RenewedMemberSubscriptionInvIDformlongNo
ChapIdformintNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
CampaignInformation Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignNameformstringNo
AmountformdecimalNo
ChapPayIDformstringNo
BillMePaymentResult Parameters:
NameParameterData TypeRequiredDescription
TransactionRecordIDformlongNo
BillMeCloudServiceResponse Parameters:
NameParameterData TypeRequiredDescription
IsDuplicateformboolNo
IsSuccessfulformboolNo
ErrorCodeformstringNo
MessageformstringNo
IsErrorformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Header":{"ClientId":0,"Referrer":"String","IpAddress":"String","LoggedInUserId":0,"GroupId":0,"Task":"String","Machine":"String","Location":"String","CreatedBy":0,"CampaignId":0},"SubscriptionInfo":{"FormTemplateID":0,"SubscriptionInvoiceID":0,"ClientSubscriberId":"String","SignupTypeID":0,"FrequencyID":0,"AutoRenew":false,"CompanyID":0,"UserID":0,"ChapMemPayID":0,"MemberSubscriptionInvID":0,"Fields":[{"Name":"String","Value":"String"}],"CreatedBy":0,"UpdatedBy":0,"AptifyUpdateType":0,"RenewedMemberSubscriptionInvID":0,"ChapId":0},"CampaignInfo":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TransactionRecordID":0,"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","IsError":false}