Billhighway Cloud API

<back to all web services

MemberSubscriptionPaymentRq

The following routes are available for this service:
GET/signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID}
namespace BH.API.CloudApi.Core

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

    [<AllowNullLiteral>]
    type MemberSubscriptionPaymentRq() = 
        member val MemberSubscriptionInvoiceId:Int32 = new Int32() with get,set

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

    [<AllowNullLiteral>]
    type CountryInfo() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val Abbr:String = null with get,set
        member val FullName:String = null with get,set
        member val IsoA2:String = null with get,set
        member val IsoNum:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type StateInfo() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val StateID:Int32 = new Int32() with get,set
        member val Abbr:String = null with get,set
        member val FullName:String = null with get,set

    [<AllowNullLiteral>]
    type GroupBrandingInfo() = 
        member val Items:ResizeArray<ApiParameter> = new ResizeArray<ApiParameter>() with get,set
        member val Countries:IEnumerable<CountryInfo> = null with get,set
        member val States:IEnumerable<StateInfo> = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionFrequency() = 
        member val ID:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val FriendlyDescription:String = null with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val InstallmentAmount:Decimal = new Decimal() with get,set
        member val NumInstallments:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoiceItem() = 
        member val ID:Int64 = new Int64() with get,set
        member val Description:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Frequencies:ResizeArray<SubscriptionFrequency> = new ResizeArray<SubscriptionFrequency>() with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoice() = 
        member val ID:Int64 = new Int64() with get,set
        member val LineageID:Int64 = new Int64() with get,set
        member val TypeID:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val InvoiceItems:ResizeArray<GroupSubscriptionInvoiceItem> = new ResizeArray<GroupSubscriptionInvoiceItem>() with get,set
        member val FrequencyTotals:ResizeArray<SubscriptionFrequency> = new ResizeArray<SubscriptionFrequency>() with get,set
        member val ClientSubscriptionTypeID:String = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoiceType() = 
        member val ID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val SubscriptionInvoices:ResizeArray<GroupSubscriptionInvoice> = new ResizeArray<GroupSubscriptionInvoice>() with get,set
        member val SubscriptionInvTemplateTypeID:Int32 = new Int32() with get,set
        member val TemplateTypeName:String = null with get,set

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

    [<AllowNullLiteral>]
    type SubscriberForm() = 
        member val ID:Int64 = new Int64() with get,set
        member val FormTempateID:Int32 = new Int32() with get,set
        member val SubscriptionInvoiceID:Int64 = new Int64() with get,set
        member val SignupTypeID:Int32 = new Int32() with get,set
        member val Fields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set

    [<AllowNullLiteral>]
    type CampaignThemeImage() = 
        member val BackgroundImage:String = null with get,set
        member val Icon:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignTheme() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MainColor:String = null with get,set
        member val SecondaryColor:String = null with get,set
        member val iPhone:CampaignThemeImage = null with get,set
        member val iPhoneRetina:CampaignThemeImage = null with get,set

    [<AllowNullLiteral>]
    type CampaignGoal() = 
        member val Target:Decimal = new Decimal() with get,set
        member val Actual:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type Signup() = 
        member val ShowOnNewMembership:Boolean = new Boolean() with get,set
        member val ShowOnSignupRenewal:Boolean = new Boolean() with get,set
        member val ShowOtherAmount:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CampaignItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val SubTitle:String = null with get,set
        member val Description:String = null with get,set
        member val HasGoal:Boolean = new Boolean() with get,set
        member val DetailUri:String = null with get,set
        member val Theme:CampaignTheme = null with get,set
        member val Goal:CampaignGoal = null with get,set
        member val Levels:CampaignLevel[] = [||] with get,set
        member val LogoUrl:String = null with get,set
        member val HighResolutionLogoUrl:String = null with get,set
        member val Signup:Signup = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInfo() = 
        member val BrandingInfo:GroupBrandingInfo = null with get,set
        member val Subscriptions:IEnumerable<GroupSubscriptionInvoiceType> = null with get,set
        member val FormInfo:SubscriberForm = null with get,set
        member val Campaigns:IEnumerable<CampaignItem> = null with get,set

    [<AllowNullLiteral>]
    type Link() = 
        member val Rel:String = null with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInfoGetRs() = 
        member val SignupInfo:GroupSubscriptionInfo = null with get,set
        member val Links:ResizeArray<Link> = new ResizeArray<Link>() with get,set

    [<AllowNullLiteral>]
    type CampaignLevel() = 
        member val Sequence:Int32 = new Int32() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set

F# MemberSubscriptionPaymentRq 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.

GET /signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SignupInfo":{"BrandingInfo":{"Items":[{"Name":"String","Value":"String"}]},"FormInfo":{"ID":0,"FormTempateID":0,"SubscriptionInvoiceID":0,"SignupTypeID":0,"Fields":[{"FormTemplateFieldID":0,"Name":"String","Value":"String"}]}},"Links":[{"Rel":"String","Url":"String"}]}