Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

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

public class MemberSubscriptionCollection : Codable
{
    public var memberSubscriptions:[MemberSubscription] = []

    required public init(){}
}

public class MemberSubscription : Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var groupId:String?
    public var userID:String?
    public var clientCompanyID:String?
    public var clientOrderID:Int?
    public var clientMemberSubscriberID:Int?
    public var clientSubscriptionTemplate:String?
    public var subscriptionID:Int?
    public var startDate:Date?
    public var endDate:Date?

    required public init(){}
}

public class MemberSubscriptionReplyCollection : IHaveErrorField, Codable
{
    public var memberSubscriptionReply:[MemberSubscriptionReply] = []
    public var isError:Bool?

    required public init(){}
}

public class MemberSubscriptionReply : Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var memberSubscriptionInvoiceId:Int?
    public var errorCode:Int?
    public var errorMessage:String?

    required public init(){}
}


Swift 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>