Billhighway Cloud API

BillMeLaterSubscription

**BillMeLaterSubscription** Parameters:
Name	Parameter	Data Type	Required
Header	query	ApiClientHeader	No
SubscriptionInfo	query	SubscriptionParameters	No
CampaignInfo	query	List<CampaignInformation>	No

**ApiClientHeader** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int	No
Referrer	form	string	No
IpAddress	form	string	No
LoggedInUserId	form	int	No
GroupId	form	int	No
Task	form	string	No
Machine	form	string	No
Location	form	string	No
CreatedBy	form	int	No
CampaignId	form	int	No

**SubscriptionParameters** Parameters:
Name	Parameter	Data Type	Required
FormTemplateID	form	int	No
SubscriptionInvoiceID	form	int	No
ClientSubscriberId	form	string	No
SignupTypeID	form	int	No
FrequencyID	form	int	No
AutoRenew	form	bool	No
CompanyID	form	long	No
UserID	form	int	No
ChapMemPayID	form	long	No
MemberSubscriptionInvID	form	long	No
Fields	form	List<SubscriberFormField>	No
CreatedBy	form	int	No
UpdatedBy	form	int	No
AptifyUpdateType	form	int	No
RenewedMemberSubscriptionInvID	form	long	No
ChapId	form	int	No

**SubscriberFormField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**CampaignInformation** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
CampaignName	form	string	No
Amount	form	decimal	No
ChapPayID	form	string	No

**BillMePaymentResult** Parameters:
Name	Parameter	Data Type	Required	Description
TransactionRecordID	form	long	No

**BillMeCloudServiceResponse** Parameters:
Name	Parameter	Data Type	Required
IsDuplicate	form	bool	No
IsSuccessful	form	bool	No
ErrorCode	form	string	No
Message	form	string	No
IsError	form	bool	No

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

HTTP + CSV

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

POST /csv/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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