Billhighway Cloud API

<back to all web services

MemberSubscriptionPaymentRq

The following routes are available for this service:
GET/signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class MemberSubscriptionPaymentRq : IApiRequest
{
    var MemberSubscriptionInvoiceId:Int? = null
}

open class GroupSubscriptionInfoGetRs : IApiResponse
{
    var SignupInfo:GroupSubscriptionInfo? = null
    var Links:ArrayList<Link> = ArrayList<Link>()
}

open class GroupSubscriptionInfo
{
    var BrandingInfo:GroupBrandingInfo? = null
    var Subscriptions:ArrayList<GroupSubscriptionInvoiceType> = ArrayList<GroupSubscriptionInvoiceType>()
    var FormInfo:SubscriberForm? = null
    var Campaigns:ArrayList<CampaignItem> = ArrayList<CampaignItem>()
}

open class GroupBrandingInfo
{
    var Items:ArrayList<ApiParameter> = ArrayList<ApiParameter>()
    var Countries:ArrayList<CountryInfo> = ArrayList<CountryInfo>()
    var States:ArrayList<StateInfo> = ArrayList<StateInfo>()
}

open class ApiParameter
{
    var Name:String? = null
    var Value:String? = null
}

open class CountryInfo
{
    var CountryID:Int? = null
    var Abbr:String? = null
    var FullName:String? = null
    var IsoA2:String? = null
    var IsoNum:Int? = null
}

open class StateInfo
{
    var CountryID:Int? = null
    var StateID:Int? = null
    var Abbr:String? = null
    var FullName:String? = null
}

open class GroupSubscriptionInvoiceType
{
    var ID:Int? = null
    var Name:String? = null
    var SubscriptionInvoices:ArrayList<GroupSubscriptionInvoice> = ArrayList<GroupSubscriptionInvoice>()
    var SubscriptionInvTemplateTypeID:Int? = null
    var TemplateTypeName:String? = null
}

open class GroupSubscriptionInvoice
{
    var ID:Long? = null
    var LineageID:Long? = null
    var TypeID:Int? = null
    var Description:String? = null
    var InvoiceItems:ArrayList<GroupSubscriptionInvoiceItem> = ArrayList<GroupSubscriptionInvoiceItem>()
    var FrequencyTotals:ArrayList<SubscriptionFrequency> = ArrayList<SubscriptionFrequency>()
    var ClientSubscriptionTypeID:String? = null
}

open class GroupSubscriptionInvoiceItem
{
    var ID:Long? = null
    var Description:String? = null
    var Amount:BigDecimal? = null
    var Frequencies:ArrayList<SubscriptionFrequency> = ArrayList<SubscriptionFrequency>()
}

open class SubscriptionFrequency
{
    var ID:Int? = null
    var Description:String? = null
    var FriendlyDescription:String? = null
    var TotalAmount:BigDecimal? = null
    var InstallmentAmount:BigDecimal? = null
    var NumInstallments:Int? = null
}

open class SubscriberForm
{
    var ID:Long? = null
    var FormTempateID:Int? = null
    var SubscriptionInvoiceID:Long? = null
    var SignupTypeID:Int? = null
    var Fields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
}

open class SubscriberFormField
{
    var Name:String? = null
    var Value:String? = null
}

open class CampaignItem
{
    var Id:Int? = null
    var Name:String? = null
    var SubTitle:String? = null
    var Description:String? = null
    var HasGoal:Boolean? = null
    var DetailUri:String? = null
    var Theme:CampaignTheme? = null
    var Goal:CampaignGoal? = null
    var Levels:ArrayList<CampaignLevel>? = null
    var LogoUrl:String? = null
    var HighResolutionLogoUrl:String? = null
    var Signup:Signup? = null
}

open class CampaignTheme
{
    var Id:Int? = null
    var Name:String? = null
    var MainColor:String? = null
    var SecondaryColor:String? = null
    var iPhone:CampaignThemeImage? = null
    var iPhoneRetina:CampaignThemeImage? = null
}

open class CampaignThemeImage
{
    var BackgroundImage:String? = null
    var Icon:String? = null
}

open class CampaignGoal
{
    var Target:BigDecimal? = null
    var Actual:BigDecimal? = null
}

open class CampaignLevel
{
    var Sequence:Int? = null
    var Amount:BigDecimal? = null
    var Description:String? = null
}

open class Signup
{
    var ShowOnNewMembership:Boolean? = null
    var ShowOnSignupRenewal:Boolean? = null
    var ShowOtherAmount:Boolean? = null
}

open class Link
{
    var Rel:String? = null
    var Url:String? = null
}

Kotlin MemberSubscriptionPaymentRq 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.

GET /signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GroupSubscriptionInfoGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Response">
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
    <d2p1:Link>
      <d2p1:Rel>String</d2p1:Rel>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:Link>
  </Links>
  <SignupInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:_x003C_BrandingInfo_x003E_k__BackingField>
      <d2p1:_x003C_Countries_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.Client" i:nil="true" />
      <d2p1:_x003C_Items_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
        <d4p1:ApiParameter>
          <d4p1:_x003C_Name_x003E_k__BackingField>String</d4p1:_x003C_Name_x003E_k__BackingField>
          <d4p1:_x003C_Value_x003E_k__BackingField>String</d4p1:_x003C_Value_x003E_k__BackingField>
        </d4p1:ApiParameter>
      </d2p1:_x003C_Items_x003E_k__BackingField>
      <d2p1:_x003C_States_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.Client" i:nil="true" />
    </d2p1:_x003C_BrandingInfo_x003E_k__BackingField>
    <d2p1:_x003C_Campaigns_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models" i:nil="true" />
    <d2p1:_x003C_FormInfo_x003E_k__BackingField>
      <d2p1:_x003C_Fields_x003E_k__BackingField>
        <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:_x003C_Fields_x003E_k__BackingField>
      <d2p1:_x003C_FormTempateID_x003E_k__BackingField>0</d2p1:_x003C_FormTempateID_x003E_k__BackingField>
      <d2p1:_x003C_ID_x003E_k__BackingField>0</d2p1:_x003C_ID_x003E_k__BackingField>
      <d2p1:_x003C_SignupTypeID_x003E_k__BackingField>0</d2p1:_x003C_SignupTypeID_x003E_k__BackingField>
      <d2p1:_x003C_SubscriptionInvoiceID_x003E_k__BackingField>0</d2p1:_x003C_SubscriptionInvoiceID_x003E_k__BackingField>
    </d2p1:_x003C_FormInfo_x003E_k__BackingField>
    <d2p1:_x003C_Subscriptions_x003E_k__BackingField i:nil="true" />
  </SignupInfo>
</GroupSubscriptionInfoGetRs>