TicketUserServices

CancelRecurringPaymentRequest

The following routes are available for this service:
POST	/recurringPayments/cancel
POST	/recurringPayments/{Id}/cancel


export class CancelRecurringPaymentResult
{
    public ok?: boolean;
    public id?: number;
    public effect?: string;
    public status?: string;
    public subscriptionLength?: number;
    public priorSubscriptionLength?: number;
    public monthsPaid?: number;
    public cancelledAt?: string;
    public reason?: string;
    public alreadyCancelled?: boolean;
    public remaining?: number;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<CancelRecurringPaymentResult>) { (Object as any).assign(this, init); }
}

export class CancelRecurringPaymentRequest
{
    public id?: number;
    public paymentTokenId?: string;
    public phone?: string;
    public reason?: string;
    public via?: string;

    public constructor(init?: Partial<CancelRecurringPaymentRequest>) { (Object as any).assign(this, init); }
}

TypeScript CancelRecurringPaymentRequest 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/cancel HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelRecurringPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Id>0</Id>
  <PaymentTokenId>String</PaymentTokenId>
  <Phone>String</Phone>
  <Reason>String</Reason>
  <Via>String</Via>
</CancelRecurringPaymentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelRecurringPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AlreadyCancelled>false</AlreadyCancelled>
  <CancelledAt>0001-01-01T00:00:00</CancelledAt>
  <Effect>String</Effect>
  <Id>0</Id>
  <Message>String</Message>
  <MonthsPaid>0</MonthsPaid>
  <Ok>false</Ok>
  <PriorSubscriptionLength>0</PriorSubscriptionLength>
  <Reason>String</Reason>
  <Remaining>0</Remaining>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <SubscriptionLength>0</SubscriptionLength>
</CancelRecurringPaymentResult>