navigateToCheckout( )

Directs site visitor to the Checkout page in the plan purchase flow.

Description

The navigateToCheckout() function redirects the site visitor to the Checkout page from any other page on your site. It also provides options to customize the Checkout and Thank You pages that come later in the plan purchase flow.

Note that the use of navigateToCheckout() will differ slightly depending on whether you use the default Plans & Pricing page or a custom one:

If you choose to use the default Plans & Pricing page, you will not be able to call navigateToCheckout() from there, but you may still call it from any other page in your site.
If you are using a custom Plans & Pricing page, you can call navigateToCheckout() on the plans page as well as anywhere else on your site.

Notes:
Setting the minStartDate and maxStartDate parameters will have no effect unless you've allowed customers to set the plan start date.
To work with the Pricing Plans API, you need to publish your site.

Syntax

function navigateToCheckout(options: CheckoutOptions): void

navigateToCheckout Parameters

NAME

TYPE

DESCRIPTION

options

CheckoutOptions

Options to customize the Checkout page and subsequent flow.

Returns

This function does not return anything.

Return Type:

void

Was this helpful?

Set a button on your site to navigate to the Checkout Page

Copy Code

1import { customPurchaseFlow } from 'wix-pricing-plans-frontend';
2
3$w.onReady(() => {
4  $w('#button').onClick(() => {
5    customPurchaseFlow.navigateToCheckout({
6      planId: 'fedb93e3-623a-487b-a47d-499f48ee3c7d',
7    });
8  });
9});