Unsubscribe customer from plan | Paid

Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.

AuthorizationBearer

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

planIdstringRequiredformat: "uuid"

The ID of the plan

customerExternalIdstringRequired

The external ID of the customer

Customer unsubscribed from plan 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	token: "YOUR_TOKEN_HERE",
6	});
7	await client.plans.unsubscribe("planId", {
8	customerExternalId: "customerExternalId",
9	});
10	}
11	main();