| POST | /recurringPayments/cancel | ||
|---|---|---|---|
| POST | /recurringPayments/{Id}/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 CancelRecurringPaymentResult:
ok: Optional[bool] = None
id: Optional[int] = None
effect: Optional[str] = None
status: Optional[str] = None
subscription_length: Optional[int] = None
prior_subscription_length: Optional[int] = None
months_paid: Optional[int] = None
cancelled_at: Optional[datetime.datetime] = None
reason: Optional[str] = None
already_cancelled: Optional[bool] = None
remaining: Optional[int] = None
status_code: Optional[int] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelRecurringPaymentRequest:
id: Optional[int] = None
payment_token_id: Optional[str] = None
phone: Optional[str] = None
reason: Optional[str] = None
via: Optional[str] = None
Python CancelRecurringPaymentRequest DTOs
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
}