Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription

export class MemberSubscription
{
    public UniqueId?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserID?: string;
    public ClientCompanyID?: string;
    public ClientOrderID?: number;
    public ClientMemberSubscriberID?: number;
    public ClientSubscriptionTemplate?: string;
    public SubscriptionID?: number;
    public StartDate?: string;
    public EndDate?: string;

    public constructor(init?: Partial<MemberSubscription>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionCollection
{
    public MemberSubscriptions?: MemberSubscription[];

    public constructor(init?: Partial<MemberSubscriptionCollection>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionReply
{
    public UniqueId?: string;
    public ClientId?: number;
    public MemberSubscriptionInvoiceId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;

    public constructor(init?: Partial<MemberSubscriptionReply>) { (Object as any).assign(this, init); }
}

export class MemberSubscriptionReplyCollection implements IHaveErrorField
{
    public MemberSubscriptionReply?: MemberSubscriptionReply[];
    public IsError?: boolean;

    public constructor(init?: Partial<MemberSubscriptionReplyCollection>) { (Object as any).assign(this, init); }
}

TypeScript MemberSubscriptionCollection 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 /subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberSubscriptionCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <MemberSubscriptions>
    <MemberSubscription>
      <ClientCompanyID>String</ClientCompanyID>
      <ClientId>0</ClientId>
      <ClientMemberSubscriberID>0</ClientMemberSubscriberID>
      <ClientOrderID>0</ClientOrderID>
      <ClientSubscriptionTemplate>String</ClientSubscriptionTemplate>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <GroupId>String</GroupId>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <SubscriptionID>0</SubscriptionID>
      <UniqueId>String</UniqueId>
      <UserID>String</UserID>
    </MemberSubscription>
  </MemberSubscriptions>
</MemberSubscriptionCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberSubscriptionReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <MemberSubscriptionReply>
    <MemberSubscriptionReply>
      <ClientId>0</ClientId>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <MemberSubscriptionInvoiceId>0</MemberSubscriptionInvoiceId>
      <UniqueId>String</UniqueId>
    </MemberSubscriptionReply>
  </MemberSubscriptionReply>
</MemberSubscriptionReplyCollection>