Billhighway Cloud API

<back to all web services

MemberSubscriptionPaymentRq

The following routes are available for this service:
GET/signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID}
import Foundation
import ServiceStack

public class MemberSubscriptionPaymentRq : IApiRequest, Codable
{
    public var memberSubscriptionInvoiceId:Int?

    required public init(){}
}

public class GroupSubscriptionInfoGetRs : IApiResponse, Codable
{
    public var signupInfo:GroupSubscriptionInfo?
    public var links:[Link] = []

    required public init(){}
}

public class GroupSubscriptionInfo : Codable
{
    public var brandingInfo:GroupBrandingInfo?
    public var subscriptions:[GroupSubscriptionInvoiceType] = []
    public var formInfo:SubscriberForm?
    public var campaigns:[CampaignItem] = []

    required public init(){}
}

public class GroupBrandingInfo : Codable
{
    public var items:[ApiParameter] = []
    public var countries:[CountryInfo] = []
    public var states:[StateInfo] = []

    required public init(){}
}

public class ApiParameter : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class CountryInfo : Codable
{
    public var countryID:Int?
    public var abbr:String?
    public var fullName:String?
    public var isoA2:String?
    public var isoNum:Int?

    required public init(){}
}

public class StateInfo : Codable
{
    public var countryID:Int?
    public var stateID:Int?
    public var abbr:String?
    public var fullName:String?

    required public init(){}
}

public class GroupSubscriptionInvoiceType : Codable
{
    public var id:Int?
    public var name:String?
    public var subscriptionInvoices:[GroupSubscriptionInvoice] = []
    public var subscriptionInvTemplateTypeID:Int?
    public var templateTypeName:String?

    required public init(){}
}

public class GroupSubscriptionInvoice : Codable
{
    public var id:Int?
    public var lineageID:Int?
    public var typeID:Int?
    public var Description:String?
    public var invoiceItems:[GroupSubscriptionInvoiceItem] = []
    public var frequencyTotals:[SubscriptionFrequency] = []
    public var clientSubscriptionTypeID:String?

    required public init(){}
}

public class GroupSubscriptionInvoiceItem : Codable
{
    public var id:Int?
    public var Description:String?
    public var amount:Double?
    public var frequencies:[SubscriptionFrequency] = []

    required public init(){}
}

public class SubscriptionFrequency : Codable
{
    public var id:Int?
    public var Description:String?
    public var friendlyDescription:String?
    public var totalAmount:Double?
    public var installmentAmount:Double?
    public var numInstallments:Int?

    required public init(){}
}

public class SubscriberForm : Codable
{
    public var id:Int?
    public var formTempateID:Int?
    public var subscriptionInvoiceID:Int?
    public var signupTypeID:Int?
    public var fields:[SubscriberFormField] = []

    required public init(){}
}

public class SubscriberFormField : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class CampaignItem : Codable
{
    public var id:Int?
    public var name:String?
    public var subTitle:String?
    public var Description:String?
    public var hasGoal:Bool?
    public var detailUri:String?
    public var theme:CampaignTheme?
    public var goal:CampaignGoal?
    public var levels:[CampaignLevel] = []
    public var logoUrl:String?
    public var highResolutionLogoUrl:String?
    public var signup:Signup?

    required public init(){}
}

public class CampaignTheme : Codable
{
    public var id:Int?
    public var name:String?
    public var mainColor:String?
    public var secondaryColor:String?
    public var iPhone:CampaignThemeImage?
    public var iPhoneRetina:CampaignThemeImage?

    required public init(){}
}

public class CampaignThemeImage : Codable
{
    public var backgroundImage:String?
    public var icon:String?

    required public init(){}
}

public class CampaignGoal : Codable
{
    public var target:Double?
    public var actual:Double?

    required public init(){}
}

public class CampaignLevel : Codable
{
    public var sequence:Int?
    public var amount:Double?
    public var Description:String?

    required public init(){}
}

public class Signup : Codable
{
    public var showOnNewMembership:Bool?
    public var showOnSignupRenewal:Bool?
    public var showOtherAmount:Bool?

    required public init(){}
}

public class Link : Codable
{
    public var rel:String?
    public var url:String?

    required public init(){}
}

Swift 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>