useBuyerJourneyCompleted

hook

UseBuyerJourneyCompletedGeneratedType

Returns true if the buyer completed submitting their order. For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.

false | true

export function useBuyerJourneyCompleted<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): boolean {
  const api = useApi<Target>();

  if ('buyerJourney' in api) {
    return useSubscription(api.buyerJourney.completed);
  }

  throw new ExtensionHasNoMethodError('buyerJourney', api.extension.target);
}