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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	ClientId: 0,
	GroupId: String,
	SubscriptionID: 0,
	PIN: 0,
	COID: 0,
	OrderID: 0,
	MSN: 0,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	SubscriptionInvoiceID: 0,
	ChapMemPayID: 0,
	FrequencyID: 0,
	AutoRenew: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	ErrorCode: 0,
	ErrorMessage: String
}