Billhighway Cloud API

<back to all web services

MemberSubscriptionPaymentRq

The following routes are available for this service:
GET/signup/api/memberSubscriptionInvoice/{memberSubscriptionInvoiceID}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberSubscriptionPaymentRq(IApiRequest):
    member_subscription_invoice_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiParameter:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CountryInfo:
    country_i_d: Optional[int] = None
    abbr: Optional[str] = None
    full_name: Optional[str] = None
    iso_a2: Optional[str] = None
    iso_num: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StateInfo:
    country_i_d: Optional[int] = None
    state_i_d: Optional[int] = None
    abbr: Optional[str] = None
    full_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupBrandingInfo:
    items: Optional[List[ApiParameter]] = None
    countries: Optional[List[CountryInfo]] = None
    states: Optional[List[StateInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionFrequency:
    id: Optional[int] = None
    description: Optional[str] = None
    friendly_description: Optional[str] = None
    total_amount: Optional[Decimal] = None
    installment_amount: Optional[Decimal] = None
    num_installments: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupSubscriptionInvoiceItem:
    id: Optional[int] = None
    description: Optional[str] = None
    amount: Optional[Decimal] = None
    frequencies: Optional[List[SubscriptionFrequency]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupSubscriptionInvoice:
    id: Optional[int] = None
    lineage_i_d: Optional[int] = None
    type_i_d: Optional[int] = None
    description: Optional[str] = None
    invoice_items: Optional[List[GroupSubscriptionInvoiceItem]] = None
    frequency_totals: Optional[List[SubscriptionFrequency]] = None
    client_subscription_type_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupSubscriptionInvoiceType:
    id: Optional[int] = None
    name: Optional[str] = None
    subscription_invoices: Optional[List[GroupSubscriptionInvoice]] = None
    subscription_inv_template_type_i_d: Optional[int] = None
    template_type_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriberFormField:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriberForm:
    id: Optional[int] = None
    form_tempate_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    signup_type_i_d: Optional[int] = None
    fields: Optional[List[SubscriberFormField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignThemeImage:
    background_image: Optional[str] = None
    icon: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignTheme:
    id: Optional[int] = None
    name: Optional[str] = None
    main_color: Optional[str] = None
    secondary_color: Optional[str] = None
    i_phone: Optional[CampaignThemeImage] = None
    i_phone_retina: Optional[CampaignThemeImage] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignGoal:
    target: Optional[Decimal] = None
    actual: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Signup:
    show_on_new_membership: Optional[bool] = None
    show_on_signup_renewal: Optional[bool] = None
    show_other_amount: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignItem:
    id: Optional[int] = None
    name: Optional[str] = None
    sub_title: Optional[str] = None
    description: Optional[str] = None
    has_goal: Optional[bool] = None
    detail_uri: Optional[str] = None
    theme: Optional[CampaignTheme] = None
    goal: Optional[CampaignGoal] = None
    levels: Optional[List[CampaignLevel]] = None
    logo_url: Optional[str] = None
    high_resolution_logo_url: Optional[str] = None
    signup: Optional[Signup] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupSubscriptionInfo:
    branding_info: Optional[GroupBrandingInfo] = None
    subscriptions: Optional[List[GroupSubscriptionInvoiceType]] = None
    form_info: Optional[SubscriberForm] = None
    campaigns: Optional[List[CampaignItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Link:
    rel: Optional[str] = None
    url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupSubscriptionInfoGetRs(IApiResponse):
    signup_info: Optional[GroupSubscriptionInfo] = None
    links: Optional[List[Link]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignLevel:
    sequence: Optional[int] = None
    amount: Optional[Decimal] = None
    description: Optional[str] = None

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