Billhighway Cloud API

<back to all web services

FormBuilderSubscriptionInvRq

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionInvoicesDto:
    subscription_invoice_id: Optional[str] = None
    description: Optional[str] = None
    template_type: Optional[str] = None
    template_type_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderSubscriptionInvRs:
    subscription_invoices: Optional[List[SubscriptionInvoicesDto]] = None

Python FormBuilderSubscriptionInvRq 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}/subscriptionTypeInfo HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderSubscriptionInvRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <subscriptionInvoices>
    <SubscriptionInvoicesDto>
      <description>String</description>
      <subscriptionInvoiceId>String</subscriptionInvoiceId>
      <templateType>String</templateType>
      <templateTypeId>String</templateTypeId>
    </SubscriptionInvoicesDto>
  </subscriptionInvoices>
</FormBuilderSubscriptionInvRs>