Billhighway Cloud API

<back to all web services

SubscriptionCreateRq

The following routes are available for this service:
POST/signup/api/nat/{natID}/group/{groupID}/subscription
POST/signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/subscription
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 SubscriberFormField:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriberFormData:
    form_template_i_d: Optional[int] = None
    signup_type_i_d: Optional[int] = None
    form_fields: Optional[List[SubscriberFormField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionInformation:
    frequency_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    auto_renew: Optional[bool] = None
    has_agreed_to_terms: Optional[bool] = None
    client_subscriber_id: Optional[str] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientVerification:
    provider: Optional[str] = None
    verification_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CcPaymentInformation:
    card_number: Optional[str] = None
    cvv: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    cardholder_name: Optional[str] = None
    country: Optional[str] = None
    billing_address: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state_province: Optional[str] = None
    postal_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentInformation:
    account_holder_name: Optional[str] = None
    check_number: Optional[str] = None
    routing_number: Optional[str] = None
    account_number: Optional[str] = None
    account_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignInformation:
    campaign_id: Optional[int] = None
    campaign_name: Optional[str] = None
    amount: Optional[Decimal] = None
    chap_pay_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillMeLaterInformation:
    is_bill_me_later_payment: Optional[bool] = None
    is_bill_me_later_subscription: Optional[bool] = None
    member_subscription_inv_id: Optional[int] = None
    campaigns: Optional[List[CampaignInformation]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionCreateRq:
    nat_i_d: Optional[int] = None
    group_i_d: Optional[int] = None
    client_group_i_d: Optional[str] = None
    user_type: Optional[str] = None
    user_i_d: Optional[str] = None
    form_data: Optional[SubscriberFormData] = None
    subscription_info: Optional[SubscriptionInformation] = None
    verification_info: Optional[ClientVerification] = None
    cc_payment_info: Optional[CcPaymentInformation] = None
    ach_payment_info: Optional[AchPaymentInformation] = None
    bill_me_later: Optional[BillMeLaterInformation] = None
    campaigns: Optional[List[CampaignInformation]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionCreateRs:
    is_success: Optional[bool] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    billhighway_user_id: Optional[int] = None
    confirmation_number: Optional[str] = None
    payment_confirmation_number: Optional[int] = None
    subscription_confirmation_number: Optional[int] = None
    error_code: Optional[str] = None
    message: Optional[str] = None
    friendly_message: Optional[str] = None

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

POST /signup/api/nat/{natID}/group/{groupID}/subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubscriptionCreateRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Request">
  <AchPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AccountHolderName>String</d2p1:AccountHolderName>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:CheckNumber>String</d2p1:CheckNumber>
    <d2p1:RoutingNumber>String</d2p1:RoutingNumber>
  </AchPaymentInfo>
  <BillMeLater xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Campaigns>
      <d2p1:CampaignInformation>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:CampaignId>0</d2p1:CampaignId>
        <d2p1:CampaignName>String</d2p1:CampaignName>
        <d2p1:ChapPayID>String</d2p1:ChapPayID>
      </d2p1:CampaignInformation>
    </d2p1:Campaigns>
    <d2p1:IsBillMeLaterPayment>false</d2p1:IsBillMeLaterPayment>
    <d2p1:IsBillMeLaterSubscription>false</d2p1:IsBillMeLaterSubscription>
    <d2p1:MemberSubscriptionInvId>0</d2p1:MemberSubscriptionInvId>
  </BillMeLater>
  <Campaigns xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:CampaignInformation>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:CampaignId>0</d2p1:CampaignId>
      <d2p1:CampaignName>String</d2p1:CampaignName>
      <d2p1:ChapPayID>String</d2p1:ChapPayID>
    </d2p1:CampaignInformation>
  </Campaigns>
  <CcPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BillingAddress>String</d2p1:BillingAddress>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardholderName>String</d2p1:CardholderName>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Cvv>String</d2p1:Cvv>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateProvince>String</d2p1:StateProvince>
  </CcPaymentInfo>
  <ClientGroupID>String</ClientGroupID>
  <FormData xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:FormFields>
      <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:FormFields>
    <d2p1:FormTemplateID>0</d2p1:FormTemplateID>
    <d2p1:SignupTypeID>0</d2p1:SignupTypeID>
  </FormData>
  <GroupID>0</GroupID>
  <NatID>0</NatID>
  <SubscriptionInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AutoRenew>false</d2p1:AutoRenew>
    <d2p1:ClientSubscriberId>String</d2p1:ClientSubscriberId>
    <d2p1:FrequencyID>0</d2p1:FrequencyID>
    <d2p1:HasAgreedToTerms>false</d2p1:HasAgreedToTerms>
    <d2p1:RenewedMemberSubscriptionInvID>0</d2p1:RenewedMemberSubscriptionInvID>
    <d2p1:SubscriptionInvoiceID>0</d2p1:SubscriptionInvoiceID>
  </SubscriptionInfo>
  <UserID>String</UserID>
  <UserType>String</UserType>
  <VerificationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Provider>String</d2p1:Provider>
    <d2p1:VerificationCode>String</d2p1:VerificationCode>
  </VerificationInfo>
</SubscriptionCreateRq>

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

<SubscriptionCreateRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Response">
  <BillhighwayUserId>0</BillhighwayUserId>
  <ClientId>0</ClientId>
  <ConfirmationNumber>String</ConfirmationNumber>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>String</ErrorCode>
  <FriendlyMessage>String</FriendlyMessage>
  <IsSuccess>false</IsSuccess>
  <Message>String</Message>
  <PaymentConfirmationNumber>0</PaymentConfirmationNumber>
  <SubscriptionConfirmationNumber>0</SubscriptionConfirmationNumber>
  <UniqueId>String</UniqueId>
</SubscriptionCreateRs>