FynnInstall

Summary

Cancel a subscription

Inputs

• subscriptionId (required) — The UUID of the subscription to cancel.
• cancellationDateType (required) — How the cancellation date should be interpreted (immediate, next_possible, custom).
• cancellationDate (required) — The date when the subscription should be cancelled; required only when cancellationDateType is custom.
• sendConfirmationEmail — Whether to send a confirmation email to the customer.
• reason — Reason code for cancelling the subscription.
• requestOptions — Additional request configuration such as batching, proxy, timeout, etc.

Output shape

a confirmation object indicating success or failure

On success the operation returns a success status; on error it returns an error envelope with details.

Examples

Example 1: Cancel a subscription immediately

subscriptionId: 123e4567-e89b-12d3-a456-426614174000, cancellationDateType: immediate

Example 2: Cancel at next possible date

subscriptionId: 9a8b7c6d-d5e4-f3a2-b1c0-d9e8f7a6b5c4, cancellationDateType: next_possible

Example 3: Cancel with custom date and confirmation email

subscriptionId: 5f4e3d2c-b1a0-9876-5432-10fedcba9876, cancellationDateType: custom, cancellationDate: 2025-01-01T00:00:00Z, sendConfirmationEmail: true