POST | /subscription/cancel |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UniqueId | body | string | No | |
ClientId | body | int | No | |
GroupId | body | string | No | |
SubscriptionID | body | long | No | |
PIN | body | long | No | |
COID | body | long | No | |
OrderID | body | long | No | |
MSN | body | long | No | |
StartDate | body | DateTime | No | |
EndDate | body | DateTime | No | |
SubscriptionInvoiceID | body | int | No | |
ChapMemPayID | body | int | No | |
FrequencyID | body | int | No | |
AutoRenew | body | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UniqueId | form | string | No | |
ErrorCode | form | int | No | |
ErrorMessage | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }