| POST | /signup/api/nat/{natID}/group/{groupID}/subscription | ||
|---|---|---|---|
| POST | /signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/subscription |
export class SubscriberFormField
{
public Name?: string;
public Value?: string;
public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}
export class SubscriberFormData
{
public FormTemplateID?: number;
public SignupTypeID?: number;
public FormFields?: SubscriberFormField[];
public constructor(init?: Partial<SubscriberFormData>) { (Object as any).assign(this, init); }
}
export class SubscriptionInformation
{
public FrequencyID?: number;
public SubscriptionInvoiceID?: number;
public AutoRenew?: boolean;
public HasAgreedToTerms?: boolean;
public ClientSubscriberId?: string;
public RenewedMemberSubscriptionInvID?: number;
public constructor(init?: Partial<SubscriptionInformation>) { (Object as any).assign(this, init); }
}
export class ClientVerification
{
public Provider?: string;
public VerificationCode?: string;
public constructor(init?: Partial<ClientVerification>) { (Object as any).assign(this, init); }
}
export class CcPaymentInformation
{
public CardNumber?: string;
public Cvv?: string;
public ExpMonth?: number;
public ExpYear?: number;
public CardholderName?: string;
public Country?: string;
public BillingAddress?: string;
public Address1?: string;
public Address2?: string;
public City?: string;
public StateProvince?: string;
public PostalCode?: string;
public constructor(init?: Partial<CcPaymentInformation>) { (Object as any).assign(this, init); }
}
export class AchPaymentInformation
{
public AccountHolderName?: string;
public CheckNumber?: string;
public RoutingNumber?: string;
public AccountNumber?: string;
public AccountType?: string;
public constructor(init?: Partial<AchPaymentInformation>) { (Object as any).assign(this, init); }
}
export class CampaignInformation
{
public CampaignId?: number;
public CampaignName?: string;
public Amount?: number;
public ChapPayID?: string;
public constructor(init?: Partial<CampaignInformation>) { (Object as any).assign(this, init); }
}
export class BillMeLaterInformation
{
public IsBillMeLaterPayment?: boolean;
public IsBillMeLaterSubscription?: boolean;
public MemberSubscriptionInvId?: number;
public Campaigns?: CampaignInformation[];
public constructor(init?: Partial<BillMeLaterInformation>) { (Object as any).assign(this, init); }
}
export class SubscriptionCreateRq
{
public NatID?: number;
public GroupID?: number;
public ClientGroupID?: string;
public UserType?: string;
public UserID?: string;
public FormData?: SubscriberFormData;
public SubscriptionInfo?: SubscriptionInformation;
public VerificationInfo?: ClientVerification;
public CcPaymentInfo?: CcPaymentInformation;
public AchPaymentInfo?: AchPaymentInformation;
public BillMeLater?: BillMeLaterInformation;
public Campaigns?: CampaignInformation[];
public constructor(init?: Partial<SubscriptionCreateRq>) { (Object as any).assign(this, init); }
}
export class SubscriptionCreateRs
{
public IsSuccess?: boolean;
public UniqueId?: string;
public CreatedDateTime?: string;
public ClientId?: number;
public BillhighwayUserId?: number;
public ConfirmationNumber?: string;
public PaymentConfirmationNumber?: number;
public SubscriptionConfirmationNumber?: number;
public ErrorCode?: string;
public Message?: string;
public FriendlyMessage?: string;
public constructor(init?: Partial<SubscriptionCreateRs>) { (Object as any).assign(this, init); }
}
TypeScript 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>