Billhighway Cloud API

<back to all web services

CancelMemberSubscription

The following routes are available for this service:
POST/subscription/cancel
namespace BH.CloudAPI.Common4.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CancelMemberSubscription() = 
        member val UniqueId:String = null with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val SubscriptionID:Int64 = new Int64() with get,set
        member val PIN:Int64 = new Int64() with get,set
        member val COID:Int64 = new Int64() with get,set
        member val OrderID:Int64 = new Int64() with get,set
        member val MSN:Int64 = new Int64() with get,set
        member val StartDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set
        member val SubscriptionInvoiceID:Int32 = new Int32() with get,set
        member val ChapMemPayID:Int32 = new Int32() with get,set
        member val FrequencyID:Int32 = new Int32() with get,set
        member val AutoRenew:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CancelMemberSubscriptionReply() = 
        member val UniqueId:String = null with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set

F# CancelMemberSubscription 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/cancel HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelMemberSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AutoRenew>false</AutoRenew>
  <COID>0</COID>
  <ChapMemPayID>0</ChapMemPayID>
  <ClientId>0</ClientId>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <FrequencyID>0</FrequencyID>
  <GroupId>String</GroupId>
  <MSN>0</MSN>
  <OrderID>0</OrderID>
  <PIN>0</PIN>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <SubscriptionID>0</SubscriptionID>
  <SubscriptionInvoiceID>0</SubscriptionInvoiceID>
  <UniqueId>String</UniqueId>
</CancelMemberSubscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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