Billhighway Cloud API

<back to all web services

MemberStatusValues

The following routes are available for this service:
GET/members/StatusValues
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 AutoPayInfo:
    payment_method: Optional[str] = None
    card_type: Optional[str] = None
    card_reference: Optional[str] = None
    card_number_last_four: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    ach_reference: Optional[str] = None
    payer_name: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    billing_city: Optional[str] = None
    billing_state: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    account_number_last_four: Optional[str] = None
    routing_number_last_four: Optional[str] = None
    account_type: Optional[str] = None
    last_auto_pay_amount: Optional[str] = None
    last_auto_pay_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberStatusValuesReply(IHaveErrorField):
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    billing_type_id: Optional[int] = None
    member_status_id: Optional[int] = None
    member_status_code: Optional[str] = None
    member_status_desc: Optional[str] = None
    member_type_id: Optional[int] = None
    member_type_code: Optional[str] = None
    member_type_desc: Optional[str] = None
    current_balance: Optional[str] = None
    auto_pay_status: Optional[str] = None
    auto_pay_info: Optional[AutoPayInfo] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberStatusValues:
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None

Python MemberStatusValues DTOs

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

HTTP + JSV

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

GET /members/StatusValues HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClientId: 0,
	GroupId: String,
	ErrorCode: 0,
	ErrorMessage: String,
	UserId: String,
	BhUserId: 0,
	BillingTypeId: 0,
	MemberStatusId: 0,
	MemberStatusCode: String,
	MemberStatusDesc: String,
	MemberTypeId: 0,
	MemberTypeCode: String,
	MemberTypeDesc: String,
	CurrentBalance: String,
	AutoPayStatus: String,
	AutoPayInfo: 
	{
		PaymentMethod: String,
		CardType: String,
		CardReference: String,
		CardNumberLastFour: String,
		ExpMonth: 0,
		ExpYear: 0,
		AchReference: String,
		PayerName: String,
		Address1: String,
		Address2: String,
		BillingCity: String,
		BillingState: String,
		PostalCode: String,
		Country: String,
		AccountNumberLastFour: String,
		RoutingNumberLastFour: String,
		AccountType: String,
		LastAutoPayAmount: String,
		LastAutoPayDate: String
	},
	IsError: False
}