| POST | /signup/api/nat/{natID}/group/{groupID}/subscription | ||
|---|---|---|---|
| POST | /signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/subscription |
import Foundation
import ServiceStack
public class SubscriptionCreateRq : Codable
{
public var natID:Int?
public var groupID:Int?
public var clientGroupID:String?
public var userType:String?
public var userID:String?
public var formData:SubscriberFormData?
public var subscriptionInfo:SubscriptionInformation?
public var verificationInfo:ClientVerification?
public var ccPaymentInfo:CcPaymentInformation?
public var achPaymentInfo:AchPaymentInformation?
public var billMeLater:BillMeLaterInformation?
public var campaigns:[CampaignInformation] = []
required public init(){}
}
public class SubscriberFormData : Codable
{
public var formTemplateID:Int?
public var signupTypeID:Int?
public var formFields:[SubscriberFormField] = []
required public init(){}
}
public class SubscriberFormField : Codable
{
public var name:String?
public var value:String?
required public init(){}
}
public class SubscriptionInformation : Codable
{
public var frequencyID:Int?
public var subscriptionInvoiceID:Int?
public var autoRenew:Bool?
public var hasAgreedToTerms:Bool?
public var clientSubscriberId:String?
public var renewedMemberSubscriptionInvID:Int?
required public init(){}
}
public class ClientVerification : Codable
{
public var provider:String?
public var verificationCode:String?
required public init(){}
}
public class CcPaymentInformation : Codable
{
public var cardNumber:String?
public var cvv:String?
public var expMonth:Int?
public var expYear:Int?
public var cardholderName:String?
public var country:String?
public var billingAddress:String?
public var address1:String?
public var address2:String?
public var city:String?
public var stateProvince:String?
public var postalCode:String?
required public init(){}
}
public class AchPaymentInformation : Codable
{
public var accountHolderName:String?
public var checkNumber:String?
public var routingNumber:String?
public var accountNumber:String?
public var accountType:String?
required public init(){}
}
public class BillMeLaterInformation : Codable
{
public var isBillMeLaterPayment:Bool?
public var isBillMeLaterSubscription:Bool?
public var memberSubscriptionInvId:Int?
public var campaigns:[CampaignInformation] = []
required public init(){}
}
public class CampaignInformation : Codable
{
public var campaignId:Int?
public var campaignName:String?
public var amount:Double?
public var chapPayID:String?
required public init(){}
}
public class SubscriptionCreateRs : Codable
{
public var isSuccess:Bool?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var billhighwayUserId:Int?
public var confirmationNumber:String?
public var paymentConfirmationNumber:Int?
public var subscriptionConfirmationNumber:Int?
public var errorCode:String?
public var message:String?
public var friendlyMessage:String?
required public init(){}
}
Swift SubscriptionCreateRq DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>