Embedded checkout allows you to embed Whop’s checkout flow on your own website in two easy steps. This allows you to offer your users a seamless checkout experience without leaving your website.

​
React

​
Step 1: Install the package

npm install @whop/react

​
Step 2: Add the checkout element

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

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.

​
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.

​
hidePrice

Optional - Turn on to hide the price 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 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"
/>

​
Full example

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

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

​
Framer

To embed Whop checkout in a Framer project, you can utilize Framer Code components with the Whop React SDK.

​
Step 1: Create a new Framer Code component

Navigate to the Assets tab in your framer project, click the + button next to Code and select New Code File.

​
Step 2: Add the checkout embed code component

You do not have to install the package explicitly. Framer will automatically detect and install the package for you.

Paste the following code into the editor:

import {
  WhopFramerCheckoutEmbed,
  propertyControls,
} from "@whop/framer/checkout";
import { addPropertyControls } from "framer";

/**
 * @framerSupportedLayoutWidth auto
 * @framerSupportedLayoutHeight auto
 */
export default function WhopCheckoutEmbed(props) {
  return <WhopFramerCheckoutEmbed {...props} />;
}

addPropertyControls(WhopCheckoutEmbed, propertyControls);

You can now use the checkout embed component in your project and configure it through the framer interface.

​
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.

​
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

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.

<div data-whop-checkout-session="ch_XXXXXXXXX" 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-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-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-email

Used to prefill the email 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>

​
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>