PayFanout API reference
    Preparing search index...

    Interface CancelNativeSubscriptionInput

    Cancellation must be VERIFIED-IDEMPOTENT: adapters treat an already-terminal subscription as success (re-fetching on a cancel rejection where needed), so a replayed cancel can never fail an adoption flow that depends on stopping PSP-side billing exactly once.

    interface CancelNativeSubscriptionInput {
        idempotencyKey: string;
        savedPaymentMethodToken?: string;
        subscriptionId: string;
    }
    Index
    idempotencyKey savedPaymentMethodToken? subscriptionId
    idempotencyKey: string

    Cancel stops money movement — mutating, so the key is required.

    savedPaymentMethodToken?: string

    Required by PSPs that key subscriptions by id + vault token (PayZen).

    subscriptionId: string

    The PSP's subscription id (NativeSubscriptionRecord.id).

    Settings
    Member Visibility

    On This Page
    Properties