Billhighway Cloud API

<back to all web services

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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.Subscriptions.Request;
using BH.CloudAPI.Common4.DTO.Subscriptions;
using BH.CloudAPI.Common4.DTO.SalesForce;
using BH.CloudAPI.Common4.DTO.Subscriptions.Response;

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class SubscriberFormField
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
    public partial class AchPaymentInformation
    {
        public virtual string AccountHolderName { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumber { get; set; }
        public virtual string AccountType { get; set; }
    }

    public partial class BillMeLaterInformation
    {
        public BillMeLaterInformation()
        {
            Campaigns = new List<CampaignInformation>{};
        }

        public virtual bool IsBillMeLaterPayment { get; set; }
        public virtual bool IsBillMeLaterSubscription { get; set; }
        public virtual int MemberSubscriptionInvId { get; set; }
        public virtual List<CampaignInformation> Campaigns { get; set; }
    }

    public partial class CampaignInformation
    {
        public virtual int CampaignId { get; set; }
        public virtual string CampaignName { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ChapPayID { get; set; }
    }

    public partial class CcPaymentInformation
    {
        public virtual string CardNumber { get; set; }
        public virtual string Cvv { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string CardholderName { get; set; }
        public virtual string Country { get; set; }
        public virtual string BillingAddress { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string StateProvince { get; set; }
        public virtual string PostalCode { get; set; }
    }

    public partial class ClientVerification
    {
        public virtual string Provider { get; set; }
        public virtual string VerificationCode { get; set; }
    }

    public partial class SubscriberFormData
    {
        public SubscriberFormData()
        {
            FormFields = new List<SubscriberFormField>{};
        }

        public virtual int FormTemplateID { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual List<SubscriberFormField> FormFields { get; set; }
    }

    public partial class SubscriptionInformation
    {
        public virtual int FrequencyID { get; set; }
        public virtual int SubscriptionInvoiceID { get; set; }
        public virtual bool AutoRenew { get; set; }
        public virtual bool HasAgreedToTerms { get; set; }
        public virtual string ClientSubscriberId { get; set; }
        public virtual int RenewedMemberSubscriptionInvID { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions.Request
{
    public partial class SubscriptionCreateRq
    {
        public SubscriptionCreateRq()
        {
            Campaigns = new List<CampaignInformation>{};
        }

        public virtual int NatID { get; set; }
        public virtual int GroupID { get; set; }
        public virtual string ClientGroupID { get; set; }
        public virtual string UserType { get; set; }
        public virtual string UserID { get; set; }
        public virtual SubscriberFormData FormData { get; set; }
        public virtual SubscriptionInformation SubscriptionInfo { get; set; }
        public virtual ClientVerification VerificationInfo { get; set; }
        public virtual CcPaymentInformation CcPaymentInfo { get; set; }
        public virtual AchPaymentInformation AchPaymentInfo { get; set; }
        public virtual BillMeLaterInformation BillMeLater { get; set; }
        public virtual List<CampaignInformation> Campaigns { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions.Response
{
    public partial class SubscriptionCreateRs
    {
        public virtual bool IsSuccess { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int BillhighwayUserId { get; set; }
        public virtual string ConfirmationNumber { get; set; }
        public virtual long PaymentConfirmationNumber { get; set; }
        public virtual long SubscriptionConfirmationNumber { get; set; }
        public virtual string ErrorCode { get; set; }
        public virtual string Message { get; set; }
        public virtual string FriendlyMessage { get; set; }
    }

}

C# SubscriptionCreateRq DTOs

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>