TicketUserServices

<back to all web services

StopRecurringPaymentRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST/recurringPayments/stop
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 StopRecurringPaymentResult:
    ok: Optional[bool] = None
    id: Optional[int] = None
    effect: Optional[str] = None
    status: Optional[str] = None
    subscription_length: Optional[int] = None
    months_paid: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StopRecurringPaymentRequest:
    id: Optional[int] = None
    payment_token_id: Optional[str] = None
    owner_id: Optional[int] = None
    reason: Optional[str] = None
    via: Optional[str] = None

Python StopRecurringPaymentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recurringPayments/stop HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StopRecurringPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Id>0</Id>
  <OwnerId>0</OwnerId>
  <PaymentTokenId>String</PaymentTokenId>
  <Reason>String</Reason>
  <Via>String</Via>
</StopRecurringPaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StopRecurringPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Effect>String</Effect>
  <Id>0</Id>
  <Message>String</Message>
  <MonthsPaid>0</MonthsPaid>
  <Ok>false</Ok>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <SubscriptionLength>0</SubscriptionLength>
</StopRecurringPaymentResult>