| Requires the role: | Admin |
| POST | /recurringPayments/stop |
|---|
export class StopRecurringPaymentResult
{
public ok?: boolean;
public id?: number;
public effect?: string;
public status?: string;
public subscriptionLength?: number;
public monthsPaid?: number;
public statusCode?: number;
public message?: string;
public constructor(init?: Partial<StopRecurringPaymentResult>) { (Object as any).assign(this, init); }
}
export class StopRecurringPaymentRequest
{
public id?: number;
public paymentTokenId?: string;
public ownerId?: number;
public reason?: string;
public via?: string;
public constructor(init?: Partial<StopRecurringPaymentRequest>) { (Object as any).assign(this, init); }
}
TypeScript StopRecurringPaymentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>