Billhighway Cloud API

<back to all web services

CancelMemberSubscription

The following routes are available for this service:
POST/subscription/cancel
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 CancelMemberSubscription:
    unique_id: Optional[str] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    subscription_i_d: Optional[int] = None
    pin: Optional[int] = None
    coid: Optional[int] = None
    order_i_d: Optional[int] = None
    msn: Optional[int] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    subscription_invoice_i_d: Optional[int] = None
    chap_mem_pay_i_d: Optional[int] = None
    frequency_i_d: Optional[int] = None
    auto_renew: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelMemberSubscriptionReply:
    unique_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None

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