TicketUserServices

<back to all web services

CancelRecurringPaymentRequest

Requires Authentication
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 .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
}