Cancel order renewal | Paid

Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

orderIdstringRequired

The order ID (can be internal ID or display ID)

This endpoint expects an object.

orderVersionintegerRequired>=1

The current version of the order (for optimistic locking)

cancelFromDatedatetimeRequired

The date from which the renewal should be cancelled (ISO 8601 format)

Order renewal cancelled successfully

orderIdstringformat: "uuid"

The ID of the order

amendmentIdstringformat: "uuid"

The ID of the amendment record

versioninteger

The new version of the order after the amendment

endDatedatetime

The new end date of the order

effectiveDatedatetime

The effective date of the cancellation

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	environment: "https://api.agentpaid.io/api/v1",
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.orders.cancelRenewal("orderId", {
9	orderVersion: 1,
10	cancelFromDate: new Date("2025-12-31T00:00:00.000Z"),
11	});
12	}
13	main();