Billhighway Cloud API

<back to all web services

BillMeLaterSubscription

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.DTO;
using BH.CloudAPI.Common4.DTO.SalesForce;
using BH.CloudAPI.Common4.DTO.Subscriptions;

namespace BH.CloudAPI.Common.DTO
{
    public partial class ApiClientHeader
    {
        public virtual int ClientId { get; set; }
        public virtual string Referrer { get; set; }
        public virtual string IpAddress { get; set; }
        public virtual int LoggedInUserId { get; set; }
        public virtual int GroupId { get; set; }
        public virtual string Task { get; set; }
        public virtual string Machine { get; set; }
        public virtual string Location { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual int CampaignId { get; set; }
        public virtual decimal? ReCaptchaScore { get; set; }
    }

    public partial class BillMeCloudServiceResponse
    {
        public virtual bool IsDuplicate { get; set; }
        public virtual bool IsSuccessful { get; set; }
        public virtual string ErrorCode { get; set; }
        public virtual string Message { get; set; }
        public virtual bool IsError { get; set; }
    }

    public partial class BillMePaymentResult
        : BillMeCloudServiceResponse
    {
        public virtual long TransactionRecordID { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class BillMeLaterSubscription
    {
        public BillMeLaterSubscription()
        {
            CampaignInfo = new List<CampaignInformation>{};
        }

        public virtual ApiClientHeader Header { get; set; }
        public virtual SubscriptionParameters SubscriptionInfo { get; set; }
        public virtual List<CampaignInformation> CampaignInfo { get; set; }
    }

}

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

    public partial class SubscriptionParameters
    {
        public SubscriptionParameters()
        {
            Fields = new List<SubscriberFormField>{};
        }

        public virtual int FormTemplateID { get; set; }
        public virtual int SubscriptionInvoiceID { get; set; }
        public virtual string ClientSubscriberId { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual int FrequencyID { get; set; }
        public virtual bool AutoRenew { get; set; }
        public virtual long CompanyID { get; set; }
        public virtual int UserID { get; set; }
        public virtual long ChapMemPayID { get; set; }
        public virtual long MemberSubscriptionInvID { get; set; }
        public virtual List<SubscriberFormField> Fields { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual int UpdatedBy { get; set; }
        public virtual int AptifyUpdateType { get; set; }
        public virtual long RenewedMemberSubscriptionInvID { get; set; }
        public virtual int ChapId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
    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; }
    }

}

C# BillMeLaterSubscription 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 /xml/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BillMeLaterSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <CampaignInfo 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>
  </CampaignInfo>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <d2p1:CampaignId>0</d2p1:CampaignId>
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:GroupId>0</d2p1:GroupId>
    <d2p1:IpAddress>String</d2p1:IpAddress>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:LoggedInUserId>0</d2p1:LoggedInUserId>
    <d2p1:Machine>String</d2p1:Machine>
    <d2p1:ReCaptchaScore>0</d2p1:ReCaptchaScore>
    <d2p1:Referrer>String</d2p1:Referrer>
    <d2p1:Task>String</d2p1:Task>
  </Header>
  <SubscriptionInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
    <d2p1:AptifyUpdateType>0</d2p1:AptifyUpdateType>
    <d2p1:AutoRenew>false</d2p1:AutoRenew>
    <d2p1:ChapId>0</d2p1:ChapId>
    <d2p1:ChapMemPayID>0</d2p1:ChapMemPayID>
    <d2p1:ClientSubscriberId>String</d2p1:ClientSubscriberId>
    <d2p1:CompanyID>0</d2p1:CompanyID>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:Fields>
      <d2p1:SubscriberFormField>
        <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:Fields>
    <d2p1:FormTemplateID>0</d2p1:FormTemplateID>
    <d2p1:FrequencyID>0</d2p1:FrequencyID>
    <d2p1:MemberSubscriptionInvID>0</d2p1:MemberSubscriptionInvID>
    <d2p1:RenewedMemberSubscriptionInvID>0</d2p1:RenewedMemberSubscriptionInvID>
    <d2p1:SignupTypeID>0</d2p1:SignupTypeID>
    <d2p1:SubscriptionInvoiceID>0</d2p1:SubscriptionInvoiceID>
    <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
    <d2p1:UserID>0</d2p1:UserID>
  </SubscriptionInfo>
</BillMeLaterSubscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillMePaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ErrorCode>String</ErrorCode>
  <IsDuplicate>false</IsDuplicate>
  <IsError>false</IsError>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <TransactionRecordID>0</TransactionRecordID>
</BillMePaymentResult>