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

**SubscriptionCreateRq** Parameters:
Name	Parameter	Data Type	Required
NatID	path	int	No
GroupID	path	int	No
ClientGroupID	body	string	No
UserType	path	string	No
UserID	path	string	No
FormData	body	SubscriberFormData	No
SubscriptionInfo	body	SubscriptionInformation	No
VerificationInfo	body	ClientVerification	No
CcPaymentInfo	body	CcPaymentInformation	No
AchPaymentInfo	body	AchPaymentInformation	No
BillMeLater	body	BillMeLaterInformation	No
Campaigns	body	List<CampaignInformation>	No

**SubscriberFormData** Parameters:
Name	Parameter	Data Type	Required
FormTemplateID	form	int	No
SignupTypeID	form	int	No
FormFields	form	List<SubscriberFormField>	No

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

**SubscriptionInformation** Parameters:
Name	Parameter	Data Type	Required
FrequencyID	form	int	No
SubscriptionInvoiceID	form	int	No
AutoRenew	form	bool	No
HasAgreedToTerms	form	bool	No
ClientSubscriberId	form	string	No
RenewedMemberSubscriptionInvID	form	int	No

**ClientVerification** Parameters:
Name	Parameter	Data Type	Required	Description
Provider	form	string	No
VerificationCode	form	string	No

**CcPaymentInformation** Parameters:
Name	Parameter	Data Type	Required
CardNumber	form	string	No
Cvv	form	string	No
ExpMonth	form	int	No
ExpYear	form	int	No
CardholderName	form	string	No
Country	form	string	No
BillingAddress	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
StateProvince	form	string	No
PostalCode	form	string	No

**AchPaymentInformation** Parameters:
Name	Parameter	Data Type	Required
AccountHolderName	form	string	No
CheckNumber	form	string	No
RoutingNumber	form	string	No
AccountNumber	form	string	No
AccountType	form	string	No

**BillMeLaterInformation** Parameters:
Name	Parameter	Data Type	Required
IsBillMeLaterPayment	form	bool	No
IsBillMeLaterSubscription	form	bool	No
MemberSubscriptionInvId	form	int	No
Campaigns	form	List<CampaignInformation>	No

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

**SubscriptionCreateRs** Parameters:
Name	Parameter	Data Type	Required
IsSuccess	form	bool	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
BillhighwayUserId	form	int	No
ConfirmationNumber	form	string	No
PaymentConfirmationNumber	form	long	No
SubscriptionConfirmationNumber	form	long	No
ErrorCode	form	string	No
Message	form	string	No
FriendlyMessage	form	string	No

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>