Billhighway Cloud API

<back to all web services

FormBuilderMemberBasedSubscriptionInvRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/group/{groupId}/memberBasedSubscriptionTypeInfo
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 FormBuilderMemberBasedSubscriptionInvRq(IApiRequest):
    nat_id: Optional[int] = None
    group_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMemberBasedSubscription:
    subscription_invoice_id: Optional[int] = None
    subscription_name: Optional[str] = None
    subscription_annual_amount: Optional[Decimal] = None
    status: Optional[str] = None
    subscription_template_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMemberBasedSubscriptionInvRs:
    member_based_subscriptions: Optional[List[FormBuilderMemberBasedSubscription]] = None

Python FormBuilderMemberBasedSubscriptionInvRq 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/nat/{natID}/group/{groupId}/memberBasedSubscriptionTypeInfo HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderMemberBasedSubscriptionInvRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <memberBasedSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto.FormBuilder">
    <d2p1:FormBuilderMemberBasedSubscription>
      <d2p1:status>String</d2p1:status>
      <d2p1:subscriptionAnnualAmount>0</d2p1:subscriptionAnnualAmount>
      <d2p1:subscriptionInvoiceId>0</d2p1:subscriptionInvoiceId>
      <d2p1:subscriptionName>String</d2p1:subscriptionName>
      <d2p1:subscriptionTemplateType>String</d2p1:subscriptionTemplateType>
    </d2p1:FormBuilderMemberBasedSubscription>
  </memberBasedSubscriptions>
</FormBuilderMemberBasedSubscriptionInvRs>