| POST | /recurringPayments/cancel | ||
|---|---|---|---|
| POST | /recurringPayments/{Id}/cancel |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No | |
| PaymentTokenId | body | string | No | |
| Phone | body | string | No | |
| Reason | body | string | No | |
| Via | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ok | form | bool | No | |
| Id | form | int | No | |
| Effect | form | string | No | |
| Status | form | string | No | |
| SubscriptionLength | form | int | No | |
| PriorSubscriptionLength | form | int | No | |
| MonthsPaid | form | int | No | |
| CancelledAt | form | DateTime? | No | |
| Reason | form | string | No | |
| AlreadyCancelled | form | bool | No | |
| Remaining | form | int? | No | |
| StatusCode | form | int | No | |
| Message | 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 /recurringPayments/cancel HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
paymentTokenId: String,
phone: String,
reason: String,
via: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ok: False,
id: 0,
effect: String,
status: String,
subscriptionLength: 0,
priorSubscriptionLength: 0,
monthsPaid: 0,
cancelledAt: 0001-01-01,
reason: String,
alreadyCancelled: False,
remaining: 0,
statusCode: 0,
message: String
}