Billhighway Cloud API

<back to all web services

BillMeLaterSubscription

namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiClientHeader() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val Referrer:String = null with get,set
        member val IpAddress:String = null with get,set
        member val LoggedInUserId:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set
        member val Task:String = null with get,set
        member val Machine:String = null with get,set
        member val Location:String = null with get,set
        member val CreatedBy:Int32 = new Int32() with get,set
        member val CampaignId:Int32 = new Int32() with get,set
        member val ReCaptchaScore:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type SubscriberFormField() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionParameters() = 
        member val FormTemplateID:Int32 = new Int32() with get,set
        member val SubscriptionInvoiceID:Int32 = new Int32() with get,set
        member val ClientSubscriberId:String = null with get,set
        member val SignupTypeID:Int32 = new Int32() with get,set
        member val FrequencyID:Int32 = new Int32() with get,set
        member val AutoRenew:Boolean = new Boolean() with get,set
        member val CompanyID:Int64 = new Int64() with get,set
        member val UserID:Int32 = new Int32() with get,set
        member val ChapMemPayID:Int64 = new Int64() with get,set
        member val MemberSubscriptionInvID:Int64 = new Int64() with get,set
        member val Fields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
        member val CreatedBy:Int32 = new Int32() with get,set
        member val UpdatedBy:Int32 = new Int32() with get,set
        member val AptifyUpdateType:Int32 = new Int32() with get,set
        member val RenewedMemberSubscriptionInvID:Int64 = new Int64() with get,set
        member val ChapId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CampaignInformation() = 
        member val CampaignId:Int32 = new Int32() with get,set
        member val CampaignName:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ChapPayID:String = null with get,set

    [<AllowNullLiteral>]
    type BillMeLaterSubscription() = 
        member val Header:ApiClientHeader = null with get,set
        member val SubscriptionInfo:SubscriptionParameters = null with get,set
        member val CampaignInfo:ResizeArray<CampaignInformation> = new ResizeArray<CampaignInformation>() with get,set

    [<AllowNullLiteral>]
    type BillMeCloudServiceResponse() = 
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val IsSuccessful:Boolean = new Boolean() with get,set
        member val ErrorCode:String = null with get,set
        member val Message:String = null with get,set
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BillMePaymentResult() = 
        inherit BillMeCloudServiceResponse()
        member val TransactionRecordID:Int64 = new Int64() with get,set

F# BillMeLaterSubscription DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Header":{"ClientId":0,"Referrer":"String","IpAddress":"String","LoggedInUserId":0,"GroupId":0,"Task":"String","Machine":"String","Location":"String","CreatedBy":0,"CampaignId":0,"ReCaptchaScore":0},"SubscriptionInfo":{"FormTemplateID":0,"SubscriptionInvoiceID":0,"ClientSubscriberId":"String","SignupTypeID":0,"FrequencyID":0,"AutoRenew":false,"CompanyID":0,"UserID":0,"ChapMemPayID":0,"MemberSubscriptionInvID":0,"Fields":[{"Name":"String","Value":"String"}],"CreatedBy":0,"UpdatedBy":0,"AptifyUpdateType":0,"RenewedMemberSubscriptionInvID":0,"ChapId":0},"CampaignInfo":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TransactionRecordID":0,"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","IsError":false}