onPassthrough()

Registers a listener invoked for all not-granted outcomes — when the user dismisses the offer or no offers are available. This signals “Encore didn’t result in a purchase — run your original button logic.”

Signature

onPassthrough(handler: (event: PassthroughEvent) => void): () => void

Parameters

Name	Type	Description
`handler`	`(event: PassthroughEvent) => void`	Callback receiving the passthrough event

PassthroughEvent

Field	Type	Description
`placementId`	string?	Which placement triggered this passthrough

Returns

An unsubscribe function. Call it to remove the listener.

When It Fires

Scenario	Fires?
User dismisses without purchasing	Yes
No offer available for this user	Yes
Network or system error	Yes
User accepts an offer	No — see onPurchaseRequest()

Usage

Cancel flow passthrough

const unsubscribe = Encore.onPassthrough(({ placementId }) => {
  switch (placementId) {
    case 'cancel_flow':
      proceedWithCancellation();
      break;
    case 'downgrade_flow':
      proceedWithDowngrade();
      break;
    default:
      console.log(`Passthrough for ${placementId}`);
  }
});

Use onPassthrough to ensure your original button logic still runs when Encore doesn’t intercept. For example, if a user taps “Cancel Subscription” and Encore has no offers, the passthrough handler lets you proceed with the cancellation flow.

onPurchaseComplete()completePurchaseRequest()

Getting Started

iOS SDK

Android SDK

Flutter SDK

React Native SDK

Capacitor SDK

Kotlin Multiplatform SDK

Web SDK

Integration Patterns

Automated Messaging

Offer Catalog

Offers API

Signature

Parameters

PassthroughEvent

Returns

When It Fires

Usage

Cancel flow passthrough

​Signature

​Parameters

​PassthroughEvent

​Returns

​When It Fires

​Usage

​Cancel flow passthrough

Signature

Parameters

PassthroughEvent

Returns

When It Fires

Usage

Cancel flow passthrough