TicketUserServices

<back to all web services

CancelRecurringPaymentRequest

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"paymentTokenId":"String","phone":"String","reason":"String","via":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ok":false,"id":0,"effect":"String","status":"String","subscriptionLength":0,"priorSubscriptionLength":0,"monthsPaid":0,"cancelledAt":"0001-01-01T00:00:00.0000000","reason":"String","alreadyCancelled":false,"remaining":0,"statusCode":0,"message":"String"}