TicketUserServices

<back to all web services

CancelRecurringPaymentRequest

Requires Authentication
The following routes are available for this service:
POST/recurringPayments/cancel
POST/recurringPayments/{Id}/cancel
CancelRecurringPaymentRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
PaymentTokenIdbodystringNo
PhonebodystringNo
ReasonbodystringNo
ViabodystringNo
CancelRecurringPaymentResult Parameters:
NameParameterData TypeRequiredDescription
OkformboolNo
IdformintNo
EffectformstringNo
StatusformstringNo
SubscriptionLengthformintNo
PriorSubscriptionLengthformintNo
MonthsPaidformintNo
CancelledAtformDateTime?No
ReasonformstringNo
AlreadyCancelledformboolNo
Remainingformint?No
StatusCodeformintNo
MessageformstringNo

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
}