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 Foundation
import ServiceStack

public class CancelRecurringPaymentRequest : Codable
{
    public var id:Int?
    public var paymentTokenId:String?
    public var phone:String?
    public var reason:String?
    public var via:String?

    required public init(){}
}

public class CancelRecurringPaymentResult : Codable
{
    public var ok:Bool?
    public var id:Int?
    public var effect:String?
    public var status:String?
    public var subscriptionLength:Int?
    public var priorSubscriptionLength:Int?
    public var monthsPaid:Int?
    public var cancelledAt:Date?
    public var reason:String?
    public var alreadyCancelled:Bool?
    public var remaining:Int?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}


Swift CancelRecurringPaymentRequest DTOs

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

HTTP + 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
}