Skip to content

Commit 9d8600d

Browse files
committed
Updates in Custom Benefit guide
1 parent 2e288e0 commit 9d8600d

File tree

7 files changed

+78
-60
lines changed

7 files changed

+78
-60
lines changed
79.9 KB
Loading
14.6 KB
Loading
4.57 KB
Loading
73.7 KB
Loading
74.3 KB
Loading
75.1 KB
Loading

docs/guides/custom-benefit.mdx

Lines changed: 78 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,88 @@
11
---
2-
title: "How to share links to customers after purchase automatically"
2+
title: "How to automatically share links to customers after purchase"
33
sidebarTitle: "Custom Benefit"
4-
description: "In this guide, we will walk you through how to use markdown in a Custom Benefit to share links with customers after purchase automatically."
5-
---
4+
description: "Learn how to use markdown in a Custom Benefit to automatically share links with customers after purchase."
5+
---
66

77
## Create a Custom Benefit
88
<Steps>
9-
<Step title = "Go to Benefits">
10-
In the Polar dashboard sidebar, click on **Benefits**.
9+
<Step title = "Go to Benefits">
10+
In the Polar dashboard sidebar, click on **Benefits**.
11+
You can also go directly to:
12+
`https://polar.sh/dashboard/${org_slug}/benefits`
13+
<img height="200" src="/assets/guides/custom-benefit/benefits-page.png" />
14+
</Step>
15+
<Step title = "Click on Create Benefit">
16+
Click on **Create Benefit**. You’ll see three configuration fields as shown in the image below: **Description**, **Type**, and **Private note**.
17+
<img height="200" src="/assets/guides/custom-benefit/create-benefit.png" />
18+
The **Type** field is set to Custom by default, which is what we need for sharing links, so you don’t need to change it.
19+
<Info>
20+
The **Private note** field is specific to the Custom **Type**. If you select a different **Type**, you’ll see configuration options specific to that type instead.
21+
</Info>
22+
</Step>
23+
<Step title = "Fill the configuration fields">
24+
<a id="configuration-fill"></a>
25+
Fill the **Description** and **Private note** fields.
26+
- **Description** accepts regular text.
27+
- **Private note** requires Markdown format so you can format text, add links, or lists.
28+
29+
Add your link inside the **Private note** section, formatted in Markdown, as shown in the image below.
30+
<img height="200" src="/assets/guides/custom-benefit/create-benefit-with-details.png" />
31+
Click on **Create**.
32+
</Step>
33+
<Step title = "Benefit created">
34+
The benefit is created successfully.
35+
<img height="200" src="/assets/guides/custom-benefit/benefit-created.png" />
36+
</Step>
37+
</Steps>
38+
39+
## Create a product adding Custom Benefit
40+
<Steps>
41+
<Step title="Go to Products Catalogue">
42+
In the Polar dashboard sidebar, navigate to **Products** > **Catalogue** for your organization.
1143
You can also go directly to:
12-
`https://polar.sh/dashboard/${org_slug}/benefits`
13-
<img height="200" src="/assets/guides/custom-benefit/benefits-page.png" />
14-
</Step>
15-
<Step title = "Click on Create Benefit">
16-
Click on **Create Benefit**. You’ll see three configuration fields as shown in the image below: **Description**, **Type**, and **Private note**.
17-
<img height="200" src="/assets/guides/custom-benefit/create-benefit.png" />
18-
The **Type** field is set to Custom by default, which is what we need for sharing links, so you don’t need to change it.
44+
`https://polar.sh/dashboard/${org_slug}/products`
45+
<img height="200" src="/assets/guides/custom-benefit/product-catalogue.png" />
46+
47+
</Step>
48+
<Step title = "Fill new Product information">
49+
Click on **New Product**. Fill out the Product information.
50+
<img height="200" src="/assets/guides/custom-benefit/create-product-1.png" />
51+
</Step>
52+
<Step title = "Scroll to Automated Benefits">
53+
On the Product information page, scroll to the bottom to find the **Automated Benefits** section.
54+
<img height="200" src="/assets/guides/custom-benefit/create-product2.png" />
55+
</Step>
56+
<Step title = "Select your Custom Benefit">
57+
Click on Custom to see all the custom benefits you’ve created, then toggle ON the one you want to enable.
58+
<img height="200" src="/assets/guides/custom-benefit/create-product3.png" />
1959
<Info>
20-
The **Private note** field is specific to the Custom **Type**. If you select a different **Type**, you’ll see configuration options specific to that type instead.
60+
If you don’t want to use an existing Custom benefit, you can create a new one by clicking **Create new**.
61+
Enter the configuration details, following the [Step 3](#configuration-fill) of [Create a Custom Benefit](#create-a-custom-benefit) section.
62+
<img height="200" src="/assets/guides/custom-benefit/create-product4.png" />
2163
</Info>
22-
</Step>
23-
<Step title = "Fill the configuration fields">
24-
<a id="configuration-fill"></a>
25-
Fill the **Description** and **Private note** fields.
26-
- **Description** accepts regular text.
27-
- **Private note** requires Markdown format so you can format text, add links, or lists.
28-
29-
Add your link inside the **Private note** section, formatted in Markdown, as shown in the image below.
30-
<img height="200" src="/assets/guides/custom-benefit/create-benefit-with-details.png" />
31-
Click on **Create**.
32-
</Step>
33-
<Step title = "Benefit created">
34-
The benefit is created successfully.
35-
<img height="200" src="/assets/guides/custom-benefit/benefit-created.png" />
36-
</Step>
64+
</Step>
65+
<Step title = "Product Setup complete">
66+
Click on **Create Product**.
67+
<img height="200" src="/assets/guides/custom-benefit/product-created.png" />
68+
Your product is successfully created along with the Custom benefit that allows you to share the links automatically to customers after purchase.
69+
</Step>
3770
</Steps>
3871

39-
## Create a product adding Custom Benefit
40-
<Steps>
41-
<Step title="Go to Products Catalogue">
42-
In the Polar dashboard sidebar, navigate to **Products** > **Catalogue** for your organization.
43-
You can also go directly to:
44-
`https://polar.sh/dashboard/${org_slug}/products`
45-
<img height="200" src="/assets/guides/custom-benefit/product-catalogue.png" />
46-
47-
</Step>
48-
<Step title = "Fill new Product information">
49-
Click on **New Product**. Fill out the Product information.
50-
<img height="200" src="/assets/guides/custom-benefit/create-product-1.png" />
51-
</Step>
52-
<Step title = "Scroll to Automated Benefits">
53-
On the Product information page, scroll to the bottom to find the **Automated Benefits** section.
54-
<img height="200" src="/assets/guides/custom-benefit/create-product2.png" />
55-
</Step>
56-
<Step title = "Select your Custom Benefit">
57-
Click on Custom to see all the custom benefits you’ve created, then toggle ON the one you want to enable.
58-
<img height="200" src="/assets/guides/custom-benefit/create-product3.png" />
59-
<Info>
60-
If you don’t want to use an existing Custom benefit, you can create a new one by clicking **Create new**.
61-
Enter the configuration details, following the [Step 3](#configuration-fill) of [Create a Custom Benefit](#create-a-custom-benefit) section.
62-
<img height="200" src="/assets/guides/custom-benefit/create-product4.png" />
63-
</Info>
64-
</Step>
65-
<Step title = "Product Setup complete">
66-
Click on **Create Product**.
67-
<img height="200" src="/assets/guides/custom-benefit/product-created.png" />
68-
Your product is successfully created along with the Custom benefit that allows you to share the links automatically to customers after purchase.
69-
</Step>
70-
</Steps>
72+
## How the Custom Benefit Appears During Checkout
73+
Your Custom Benefit is visible to customers at multiple stages of their purchase journey:
74+
- **Checkout Page**
75+
When a customer opens the checkout session, they’ll see the **Description of your Custom Benefit** listed under **Included**.
76+
<img height="200" src="/assets/guides/custom-benefit/checkout.png" />
77+
78+
- **After Purchase**
79+
Once the customer completes their purchase, the **Description**, the **Benefit Type** (in this case, **Custom**), and the **rendered Markdown content** from the **Private note** of the **Custom Benefit** are displayed, allowing them to access any links or formatted text you’ve added.
80+
<img height="200" src="/assets/guides/custom-benefit/purchased.png" />
81+
82+
- **Purchase Confirmation Email**
83+
The **Description** and the rendered Markdown content of the **Custom Benefit** also appear in the purchase confirmation email sent to the customer, as shown below.
84+
<img height="200" src="/assets/guides/custom-benefit/email.png" />
85+
86+
- **Customer Portal**
87+
When the customer opens the Customer Portal through the link in their confirmation email, the **Custom Benefit** is displayed there as well.
88+
<img height="200" src="/assets/guides/custom-benefit/customer-portal.png" />

0 commit comments

Comments
 (0)