Embed checkout - Whop Docs

Embedded checkout allows you to embed Whop’s checkout flow on your own website. This allows you to offer your customers a seamless checkout experience without leaving your website.

React setup

Step 1: Install the package

npm install @whop/checkout

Step 2: Add the checkout element

import { WhopCheckoutEmbed } from "@whop/checkout/react";

export default function Home() {
  return <WhopCheckoutEmbed planId="plan_XXXXXXXXX" />;
}

This component will now mount an iframe with the Whop checkout embed. Once the checkout is complete, the user will be redirected to the redirect url you specified in the settings on Whop. You can configure the redirect url in your whop’s settings or in your company’s settings on the dashboard. If both are specified, the redirect url specified in the whop’s settings will take precedence.

Keep that Plan ID handy. You’ll need to paste it into your website code, so save it somewhere you can find it.

Step 3: (optional) Configure - Programmatic controls

To get access to the controls of the checkout embed, you can use the ref prop.

const ref = useCheckoutEmbedControls();

return <WhopCheckoutEmbed ref={ref} planId="plan_XXXXXXXXX" />;

`submit`

To submit checkout programmatically, you can use the submit method on the checkout element.

ref.current?.submit();

`getEmail`

To get the email of the user who is checking out, you can use the getEmail method on the checkout element.

const email = await ref.current?.getEmail();
console.log(email);

`setEmail`

To set the email of the user who is checking out, you can use the setEmail method on the checkout element.

try {
  await ref.current?.setEmail("example@domain.com");
} catch (error) {
  console.error(error);
}

`getAddress`

To get the address of the user who is checking out, you can use the getAddress method on the checkout element.

const address = await ref.current?.getAddress();
console.log(address);

`setAddress`

To set the address of the user who is checking out, you can use the setAddress method on the checkout element.

This method will only work if the address form is hidden. You can hide the address form by setting the hideAddressForm prop to true.

try {
  await ref.current?.setAddress({
    name: "John Doe",
    country: "US",
    line1: "123 Main St",
    city: "Any Town",
    state: "CA",
    postalCode: "12345",
  });
} catch (error) {
  console.error(error);
}

Step 4: (optional) Configure - Available properties

`planId`

Required - The plan id you want to checkout.

`theme`

Optional - The theme you want to use for the checkout. Possible values are light, dark or system.

`sessionId`

Optional - The session id to use for the checkout. This can be used to attach metadata to a checkout by first creating a session through the API and then passing the session id to the checkout element.

`affiliateCode`

Optional - The affiliate code to use for the checkout.

<WhopCheckoutEmbed affiliateCode="tristan" planId="plan_XXXXXXXXX" />

`hidePrice`

Optional - Turn on to hide the price in the embedded checkout form. Defaults to false

`hideTermsAndConditions`

Optional - Set to true to hide the terms and conditions in the embedded checkout form. Defaults to false

`skipRedirect`

Optional - Set to true to skip the final redirect and keep the top frame loaded. Defaults to false

`onComplete`

Optional - A callback function that will be called when the checkout is complete.

This option will set skipRedirect to true

<WhopCheckoutEmbed
  onComplete={(planId, receiptId) => {
    console.log(planId, receiptId);
  }}
  planId="plan_XXXXXXXXX"
/>

`utm`

Optional - The UTM parameters to add to the checkout URL. Note - The keys must start with utm_

<WhopCheckoutEmbed
  planId="plan_XXXXXXXXX"
  utm={{ utm_campaign: "ad_XXXXXXX" }}
/>

`fallback`

Optional - The fallback content to show while the checkout is loading.

<WhopCheckoutEmbed fallback={<>loading...</>} planId="plan_XXXXXXXXX" />

`prefill`

Optional - The prefill options to apply to the checkout embed. Used to prefill the email or address in the embedded checkout form. This setting can be helpful when integrating the embed into a funnel that collects the email prior to payment already.

<WhopCheckoutEmbed
  prefill={{ email: "example@domain.com" }}
  planId="plan_XXXXXXXXX"
/>
<WhopCheckoutEmbed
  prefill={{ address: {
    name: "John Doe",
    country: "US",
    line1: "123 Main St",
    city: "Any Town",
    state: "CA",
    postalCode: "12345",
  } }}
  planId="plan_XXXXXXXXX"
/>

`hideEmail`

Optional - Set to true to hide the email input in the embedded checkout form. Make sure to display the users email in the parent page when setting this attribute. Defaults to false

Use this in conjunction with the prefill attribute or the setEmail method to control the email input.

<WhopCheckoutEmbed hideEmail planId="plan_XXXXXXXXX" />

`disableEmail`

Optional - Set to true to disable the email input in the embedded checkout form. Defaults to false

Use this in conjunction with the prefill attribute or the setEmail method to control the email input.

<WhopCheckoutEmbed disableEmail planId="plan_XXXXXXXXX" />

`hideAddressForm`

Optional - Set to true to hide the address form in the embedded checkout form. Defaults to false

Use this in conjunction with the setAddress method to control the address input.

<WhopCheckoutEmbed hideAddressForm planId="plan_XXXXXXXXX" />

`onAddressValidationError`

Optional - A callback function that will be called when the address validation error occurs.

This method will only work if the address form is hidden. You can hide the address form by setting the hideAddressForm prop to true.

<WhopCheckoutEmbed
  hideAddressForm
  onAddressValidationError={(error) => {
    console.log(error);
  }}
  planId="plan_XXXXXXXXX"
/>

Full example

import { WhopCheckoutEmbed } from "@whop/checkout/react";

export default function Home() {
  return (
    <WhopCheckoutEmbed
      fallback={<>loading...</>}
      planId="plan_XXXXXXXXX"
      theme="light"
      hidePrice={false}
      sessionId="ch_XXXXXXXXX"
    />
  );
}

Other websites

Step 1: Add the script tag

To embed checkout, you need to add the following script tag into the <head> of your page:

<script
  async
  defer
  src="https://js.whop.com/static/checkout/loader.js"
></script>

Step 2: Add the checkout element

To create a checkout element, you need to include the following attribute on an element in your page:

<div data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

This will now mount an iframe inside of the element with the plan id you provided. Once the checkout is complete, the user will be redirected to the redirect url you specified in the settings on Whop. You can configure the redirect url in your whop’s settings or in your company’s settings on the dashboard. If both are specified, the redirect url specified in the whop’s settings will take precedence.

Step 3: (optional) Configure - Programmatic controls

First, attach an id to the checkout container:

<div id="whop-embedded-checkout" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`submit`

To submit checkout programmatically, you can use the submit method on the checkout element.

wco.submit("whop-embedded-checkout");

`getEmail`

To get the email of the user who is checking out, you can use the getEmail method on the checkout element.

const email = await wco.getEmail("whop-embedded-checkout");
console.log(email);

`setEmail`

To set the email of the user who is checking out, you can use the setEmail method on the checkout element.

wco.setEmail("whop-embedded-checkout", "example@domain.com");

`getAddress`

To get the address of the user who is checking out, you can use the getAddress method on the checkout element.

const address = await wco.getAddress("whop-embedded-checkout");
console.log(address);

`setAddress`

To set the address of the user who is checking out, you can use the setAddress method on the checkout element.

This method will only work if the address form is hidden. You can hide the address form by setting the data-whop-checkout-hide-address prop to true.

try {
  await wco.setAddress("whop-embedded-checkout", {
    name: "John Doe",
    country: "US",
    line1: "123 Main St",
    city: "Any Town",
    state: "CA",
    postalCode: "12345",
  });
} catch (error) {
  console.error(error);
}

Step 4: (optional) Configure - Available attributes

`data-whop-checkout-plan-id`

Required - The plan id you want to checkout.

To get your plan id, you need to first create a plan in the Manage Pricing section on your whop page.

`data-whop-checkout-theme`

Optional - The theme you want to use for the checkout. Possible values are light, dark or system.

<div data-whop-checkout-theme="light" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-theme-accent-color`

Optional - The accent color to apply to the checkout embed Possible values are

tomato
red
ruby
crimson
pink
plum
purple
violet
iris
cyan
teal
jade
green
grass
brown
blue
orange
indigo
sky
mint
yellow
amber
lime
lemon
magenta
gold
bronze
gray

<div data-whop-checkout-theme-accent-color="green" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-session`

<div data-whop-checkout-session="ch_XXXXXXXXX" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-affiliate-code`

Optional - The affiliate code to use for the checkout.

<div data-whop-checkout-affiliate-code="tristan" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-hide-price`

Optional - Set to true to hide the price in the embedded checkout form. Defaults to false

<div data-whop-checkout-hide-price="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-hide-submit-button`

Optional - Set to true to hide the submit button in the embedded checkout form. Defaults to false

When using this Option, you will need to programmatically submit the checkout form.

<div data-whop-checkout-hide-submit-button="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-hide-tos`

Optional - Set to true to hide the terms and conditions in the embedded checkout form. Defaults to false

<div data-whop-checkout-hide-tos="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-skip-redirect`

Optional - Set to true to skip the final redirect and keep the top frame loaded. Defaults to false

<div data-whop-checkout-skip-redirect="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-on-complete`

Optional - The callback to call when the checkout succeeds

This option will set data-whop-checkout-skip-redirect to true

<script>
  window.onCheckoutComplete = (planId, receiptId) => {
    console.log(planId, receiptId);
  };
</script>

<div
  data-whop-checkout-on-complete="onCheckoutComplete"
  data-whop-checkout-plan-id="plan_XXXXXXXXX"
></div>

`data-whop-checkout-on-state-change`

Optional - The callback to call when state of the checkout changes This can be used when programmatically controlling the submit of the checkout embed.

<script>
  window.onCheckoutStateChange = (state) => {
    console.log(state);
  };
</script>

<div
  data-whop-checkout-on-state-change="onCheckoutStateChange"
  data-whop-checkout-plan-id="plan_XXXXXXXXX"
></div>

`data-whop-checkout-skip-utm`

By default any utm params from the main page will be forwarded to the checkout embed. Optional - Set to true to prevent the automatic forwarding of utm parameters Defaults to false

**`data-whop-checkout-prefill-*`**

Used to prefill the email or address in the embedded checkout form. This setting can be helpful when integrating the embed into a funnel that collects the email prior to payment already.

<div data-whop-checkout-prefill-email="example@domain.com" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

<div 
	data-whop-checkout-prefill-name="John Doe"
	data-whop-checkout-prefill-address-country="US"
	data-whop-checkout-prefill-address-line1="123 Main St"
	data-whop-checkout-prefill-address-line2=""
	data-whop-checkout-prefill-address-city="Any Town"
	data-whop-checkout-prefill-address-state="CA"
	data-whop-checkout-prefill-address-postal-code="12345"
	data-whop-checkout-plan-id="plan_XXXXXXXXX"
></div>

<div data-whop-checkout-prefill-address-name="John Doe" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-hide-email`

Optional - Set to true to hide the email input in the embedded checkout form. Make sure to display the users email in the parent page when setting this attribute. Defaults to false

Use this in conjunction with the data-whop-checkout-prefill-email attribute or the setEmail method to control the email input.

<div data-whop-checkout-hide-email="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-disable-email`

Optional - Set to true to disable the email input in the embedded checkout form. Defaults to false

Use this in conjunction with the data-whop-checkout-prefill-email attribute or the setEmail method to control the email input.

<div data-whop-checkout-disable-email="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-hide-address`

Optional - Set to true to hide the address form in the embedded checkout form. Defaults to false

This method will only work if the address form is hidden. You can hide the address form by setting the data-whop-checkout-hide-address prop to true.

<div data-whop-checkout-hide-address="true" data-whop-checkout-plan-id="plan_XXXXXXXXX"></div>

`data-whop-checkout-on-address-validation-error`

Optional - The callback to call when the address validation error occurs.

This method will only work if the address form is hidden. You can hide the address form by setting the data-whop-checkout-hide-address prop to true.

<script>
  window.onAddressValidationError = (error) => {
    console.log(error);
  };
</script>

<div
  data-whop-checkout-on-address-validation-error="onAddressValidationError"
  data-whop-checkout-plan-id="plan_XXXXXXXXX"
></div>

Full example

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<meta name="viewport" content="width=device-width">
		<script
			async
			defer
  			src="https://js.whop.com/static/checkout/loader.js"
		></script>
		<title>Whop embedded checkout example</title>
		<style>
			div {
				box-sizing: border-box;
			}
			body {
				margin: 0
			}
		</style>
	</head>
	<body>
		<div
			data-whop-checkout-plan-id="plan_XXXXXXXXX"
			data-whop-checkout-session="ch_XXXXXXXXX"
			data-whop-checkout-theme="light"
			data-whop-checkout-hide-price="false"
			style="height: fit-content; overflow: hidden; max-width: 50%;"
		></div>
	</body>
</html>

FAQs

Why is my checkout not loading?

Where do I find my Plan ID?

Can I embed multiple checkouts on the same page?

How do I change the checkout theme?

Can I hide the price in the embedded checkout?

What happens after a customer completes checkout?

How do I prevent the redirect after checkout?

Is the embedded checkout mobile-responsive?

Can I customize the checkout's appearance with CSS?

Can I pre-fill customer information?

Set up payment processing

Manage payments

Manage disputes

​React setup

​Step 1: Install the package

​Step 2: Add the checkout element

​Step 3: (optional) Configure - Programmatic controls

​submit

​getEmail

​setEmail

​getAddress

​setAddress

​Step 4: (optional) Configure - Available properties

​planId

​theme

​sessionId

​affiliateCode

​hidePrice

​hideTermsAndConditions

​skipRedirect

​onComplete

​utm

​fallback

​prefill

​hideEmail

​disableEmail

​hideAddressForm

​onAddressValidationError

​Full example

​Other websites

​Step 1: Add the script tag

​Step 2: Add the checkout element

​Step 3: (optional) Configure - Programmatic controls

​submit

​getEmail

​setEmail

​getAddress

​setAddress

​Step 4: (optional) Configure - Available attributes

​data-whop-checkout-plan-id

​data-whop-checkout-theme

​data-whop-checkout-theme-accent-color

​data-whop-checkout-session

​data-whop-checkout-affiliate-code

​data-whop-checkout-hide-price

​data-whop-checkout-hide-submit-button

​data-whop-checkout-hide-tos

​data-whop-checkout-skip-redirect

​data-whop-checkout-on-complete

​data-whop-checkout-on-state-change

​data-whop-checkout-skip-utm

​data-whop-checkout-prefill-*

​data-whop-checkout-hide-email

​data-whop-checkout-disable-email

​data-whop-checkout-hide-address

​data-whop-checkout-on-address-validation-error

​Full example

​FAQs

React setup

Step 1: Install the package

Step 2: Add the checkout element

Step 3: (optional) Configure - Programmatic controls

`submit`

`getEmail`

`setEmail`

`getAddress`

`setAddress`

Step 4: (optional) Configure - Available properties

`planId`

`theme`

`sessionId`

`affiliateCode`

`hidePrice`

`hideTermsAndConditions`

`skipRedirect`

`onComplete`

`utm`

`fallback`

`prefill`

`hideEmail`

`disableEmail`

`hideAddressForm`

`onAddressValidationError`

Full example

Other websites

Step 1: Add the script tag

Step 2: Add the checkout element

Step 3: (optional) Configure - Programmatic controls

`submit`

`getEmail`

`setEmail`

`getAddress`

`setAddress`

Step 4: (optional) Configure - Available attributes

`data-whop-checkout-plan-id`

`data-whop-checkout-theme`

`data-whop-checkout-theme-accent-color`

`data-whop-checkout-session`

`data-whop-checkout-affiliate-code`

`data-whop-checkout-hide-price`

`data-whop-checkout-hide-submit-button`

`data-whop-checkout-hide-tos`

`data-whop-checkout-skip-redirect`

`data-whop-checkout-on-complete`

`data-whop-checkout-on-state-change`

`data-whop-checkout-skip-utm`

**`data-whop-checkout-prefill-*`**

`data-whop-checkout-hide-email`

`data-whop-checkout-disable-email`

`data-whop-checkout-hide-address`

`data-whop-checkout-on-address-validation-error`

Full example

FAQs