Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added documentation for exporting and viewing subscription notes #1217

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/content/en/docs/Tasks/add-live-chat-to-shop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Add a Live Chat to Shop"
date: 2023-07-21
weight: 5
description: >
Need a way to talk with your customers? Leran how to Add a Live Chat to Shop
---

### Steps to Add a Live Chat to Your Subscription

Step 1: In your dashboard, open the *Integrations (Online Chat, Analytics & inject custom code)* and select *Connect to Tawk.*

![image](https://github.com/Subscribie/subscribie/assets/30567984/2863d25e-1f09-4f0e-bec8-3e7f751f3f1f)

Step 2: Create a Tawk account and copy the end of the URL in the address bar

In our example, the part to be copied is *642bc7d94247f20fefe9b017* from the URL - https://dashboard.tawk.to/?lang=en#/dashboard/642bc7d94247f20fefe9b017

> This is the string of letters and numbers after the final "/" in the address bar.

![image](https://github.com/Subscribie/subscribie/assets/30567984/bfa94df0-25c1-452d-9577-9e5aea39872a)

Step 3: Now come back to Subscribie and paste the portion of the URL that you copied into the *"Property ID:"* text box and click *Connect Tawk Chat*

![image](https://github.com/Subscribie/subscribie/assets/30567984/3ed09989-342c-401b-b3ff-f119d543639a)

### Watch the Tutorial to Add a Live Chat to Shop
[![Watch the video](https://github.com/Subscribie/subscribie/assets/30567984/62aad62a-798f-4b9c-a729-35e9bbc8a5ff)](https://youtu.be/scp5Pk2HgMU)
32 changes: 32 additions & 0 deletions docs/content/en/docs/Tasks/add-shop-to-your-website.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Add Shops to Your Existing Website"
date: 2023-07-21
weight: 5
description: >
Add your subscription shop to your existing website to redirect customers to your shop.
---

### Steps to Add Shops to Your Existing Website

Step 1: Go to your Shopify Dashboard.

![image](https://github.com/Subscribie/subscribie/assets/30567984/d0d8b35f-bdfc-48e9-a4e1-a2edfaaf38f4)

Step 2: Go to Navigation under Online Store.

![image](https://github.com/Subscribie/subscribie/assets/30567984/b89c4ee0-98c0-46e0-ad08-10e4ef1a2a6c)

Step 3: Select Main Menu.

![image](https://github.com/Subscribie/subscribie/assets/30567984/f6b32a23-a436-42c2-9d16-ac1582140499)

Step 4: Select Add Menu Item.

![image](https://github.com/Subscribie/subscribie/assets/30567984/3f963f7e-b367-4bbb-86f2-97eb05360bd3)

Step 5: Now Go to your Subscribie Shop and copy the shop link from the URL bar.

![image](https://github.com/Subscribie/subscribie/assets/30567984/fcbcb670-c489-445f-84d6-64d3175706b0)

### Watch the Tutorial for Adding Shops to Your Existing Website
[![Watch the tutorial](https://github.com/Subscribie/subscribie/assets/30567984/5e2329a9-79cb-4910-b426-ed4b90488de4)](https://youtu.be/Vs01WEUSbhM)
31 changes: 31 additions & 0 deletions docs/content/en/docs/Tasks/change-shop-header-text.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
title: "Change Shop Header Text"
date: 2023-08-11
weight: 5
description: >
Learn how you can customise the header text of your shop.
---

### Steps to Change Shop Header Text

Step 1: To change the header in your shop, Log into your Shop Dashboard.

![image](https://github.com/Subscribie/subscribie/assets/30567984/2848ad59-bb24-4181-b5e1-3a95318026d3)

Step 2: Select *Manage Catagories* under *Edit/Add Plans*

![image](https://github.com/Subscribie/subscribie/assets/30567984/fbeecf32-946b-4a44-b985-973ae672332d)

Step 3: Select Edit next to Make your choice.

![image](https://github.com/Subscribie/subscribie/assets/30567984/df461d10-c7e3-47d3-af9d-b49bb38fa4b5)

Step 4: Enter the heading you would like to add in Category Name and then Save.

![image](https://github.com/Subscribie/subscribie/assets/30567984/e45a9275-4fad-47ed-81f4-c8a3a163911f)

Now you have successfully Changed the heading of your shop on Subscribie!

![image](https://github.com/Subscribie/subscribie/assets/30567984/9709b8be-b8b2-4c67-a8b5-047c71586f99)

### Watch the Tutorial to Change Shop Header Text
[![Watch the tutorial](https://github.com/Subscribie/subscribie/assets/30567984/3c706360-23ed-4a02-b98d-bc55f8c9a7c7)](https://www.youtube.com/watch?v=-sWL0s3vNGM)
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Collect Subscriber Contact Information"
date: 2023-07-19
weight: 5
description: >
Need to get in touch with a Customer? Learn how to find your customer's contact information in your dashboard.
---

### Steps to Contact Your Subscriber

Step 1: Log into your Subscription Dashboard on Subscribie.

![image](https://github.com/Subscribie/subscribie/assets/30567984/61bd7434-b0b2-45ff-8034-1e7e134a6651)

Step 2: Navigate to *My Subscribers* and select *View Subscribers.*

![image](https://github.com/Subscribie/subscribie/assets/30567984/25c81cb2-75e1-4c36-b13f-5284eb120305)

Step 3: Here, you'll find a comprehensive list of all your subscribers.

![image](https://github.com/Subscribie/subscribie/assets/30567984/cdb258f5-4515-4c75-bb8c-73f7736a57bd)

Step 4: To find a specific customer, you can:
* Filter by *Active Subscribers* for a focused view.
* Enter their name in the search bar to locate them quickly.

> If your subscriber's name is not on the list, click Refresh Subscriptions (Learn More)

![image](https://github.com/Subscribie/subscribie/assets/30567984/47957be0-5242-4a2a-9c2d-de54311f64ba)

Step 5: Once you've found the customer you want to contact, simply copy their contact information and reach out to them using your preferred communication channel.

![image](https://github.com/Subscribie/subscribie/assets/30567984/b9dfd5b6-1ffb-4954-bc4a-68ec75a3ca6c)

### Video Tutorial for Collecting Subscriber Contact Information

[![Watch the tutorial](https://github.com/Subscribie/subscribie/assets/30567984/5772d5ec-0584-45a7-8e83-b6a362f07762)](https://www.youtube.com/watch?v=J3ww2R3C0Rg)
20 changes: 20 additions & 0 deletions docs/content/en/docs/Tasks/export-custom-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
title: "View Custom Notes"
date: 2023-08-11
weight: 5
description: >
Learn how you can view custom notes provided by customers.
---

### Steps to View Custom Notes

Step 1: Log into your shop dashboard.

![image](https://github.com/Subscribie/subscribie/assets/30567984/9a93c004-87be-4b40-9410-aec53e8b0d7e)

Step 2: In your dashboard, go to *Export Transactions* under the *All Transactions / Manage Refunds* heading.

![image](https://github.com/Subscribie/subscribie/assets/30567984/28b78893-08b0-4aa4-bed5-a1b1e08b4c12)

Step 3: Here, you can view your Subscribers' Notes in the final column with other information like Donation Comments, Plan title, Amount, Name, Email and other information.

![image](https://github.com/Subscribie/subscribie/assets/30567984/b609e1a2-4b36-4583-af7c-2c0063507565)
23 changes: 23 additions & 0 deletions docs/content/en/docs/Tasks/export-subscription-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Export Subscription Notes"
date: 2023-07-19
weight: 5
description: >
Do you need a way to export subscription notes provided by subscribers? Learn how to export subscription notes.
---

Subscription are custom notes provided by customers, you can learn [how to enable subscription notes here](https://docs.subscribie.co.uk/docs/tasks/collect-notes-from-customers). These notes are filled out when a subsciber signs up to your subscription.

### Steps to Export Subscription Notes

Step 1: Log into your shop dashboard.

![image](https://github.com/Subscribie/subscribie/assets/30567984/6b6292a5-3445-498b-9379-e2f148f46162)

Step 2: In your dashboard, go to *Export Transactions* under the *All Transactions / Manage Refunds* heading.

![image](https://github.com/Subscribie/subscribie/assets/30567984/d65a7ea5-7008-4138-8c7e-7ee5b4b172e6)

Step 3: Here, you can view your Subscribers' Notes in the final column with other information like Donation Comments, Plan title, Amount, Name, Email and other information.

![image](https://github.com/Subscribie/subscribie/assets/30567984/8a59b0b8-d050-45cd-915e-57ed451519cb)
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Learn to pause a customers subscription, this is useful if you only want to temp

## Steps to Pause a Subscriber's Subscription

Step 1:* Log into your Shop Dashboard.
Step 1: Log into your Shop Dashboard.

![](https://subscribie.co.uk/blog/content/images/size/w1000/2022/11/image-64.png)

Step 2:* Click on *"Subscribers with Active Subscriptions"* in the *"Stats"* section at the top of the dashboard.
Step 2: Click on *"Subscribers with Active Subscriptions"* in the *"Stats"* section at the top of the dashboard.

![](https://subscribie.co.uk/blog/content/images/size/w1000/2022/11/image-84.png)

Step 3:* Here, Navigate to the customer you would like to pause and select *"Pause".*
Step 3: Here, Navigate to the customer you would like to pause and select *"Pause".*

>To Unpause the Customer's Subscription, select *"Resume".*

Expand Down
35 changes: 35 additions & 0 deletions docs/content/en/docs/Tasks/view-custom-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
title: "View Custom Notes"
date: 2023-08-11
weight: 5
description: >
Learn how you can view custom notes provided by customers.
---

### Steps to View Custom Notes

Step 1: In your dashboard, go to *View Subscribers* under the *My Subscribers* heading.

![image](https://github.com/Subscribie/subscribie/assets/30567984/967858cf-2b05-4755-8454-1f4654adec49)

Step 2: Here you can find a list of all your customers with their custom order notes and other subscription details.

![image](https://github.com/Subscribie/subscribie/assets/30567984/19921ab4-88ad-4f59-9419-831f292b89ef)

Step 3: If you want to find a specific subscriber with their custom note, you can:
>Filter by *Active Subscribers* for a focused view.
>Enter their name in the search bar to locate them quickly.

![image](https://github.com/Subscribie/subscribie/assets/30567984/67a3150f-3ff8-4354-8c35-2d29f63afc7e)

### Alternatively, to view a consolidated list of all your custom order notes:

Step 1: In your dashboard, go to *View Notes* under *Order Notes*.

![image](https://github.com/Subscribie/subscribie/assets/30567984/3ecf0ab9-2714-45dc-8b34-4b6593a22327)

Step 2: Here you can view a consolidated list of all your order notes with the corresponding customer name and when the order notes were made.

![image](https://github.com/Subscribie/subscribie/assets/30567984/d6f25a5f-8940-40fc-8ea8-b61f98632571)

### Watch the Tutorial to View Custom Notes
[![Watch the tutorial](https://github.com/Subscribie/subscribie/assets/30567984/70ba1cb8-0333-4f48-a064-92dc06bceb58)](https://www.youtube.com/watch?v=-qcEDFAIxEA)
35 changes: 35 additions & 0 deletions docs/content/en/docs/Tasks/view-custom-subscription-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "View Custom Subscription Notes"
date: 2023-07-20
weight: 5
description: >
Need to view and manage subscription notes from customers? Learn how to view custom notes to tailor your subscription.
---

You can use custom subscription notes to collect additional information from customers to tailor your subscription for them or collect important details needed for your membership. Here are the steps to view custom notes.

### Steps to View Custom Notes from Subscribers

Step 1: In your dashboard, go to *View Subscribers* under the *My Subscribers* heading.

![image](https://github.com/Subscribie/subscribie/assets/30567984/de0e2ef5-6549-4692-9251-29ee4ff87144)

Step 2: Here you can find a list of all your customers with their custom order notes and other subscription details.

![image](https://github.com/Subscribie/subscribie/assets/30567984/2ceb43db-2865-41b4-a15d-1792c706723f)

Step 3: If you want to find a specific subscriber with their custom note, you can:
* Filter by *Active Subscribers* for a focused view.
* Enter their name in the search bar to locate them quickly.

![image](https://github.com/Subscribie/subscribie/assets/30567984/741f8916-4989-4e4c-9a08-3ddd27ee12a8)

### Alternatively, to view a consolidated list of all your custom order notes:

Step 1: In your dashboard, go to *View Notes* under *Order Notes*.

![image](https://github.com/Subscribie/subscribie/assets/30567984/adfa9ea4-6912-4779-a892-000fb6c331b5)

Step 2: Here you can view a consolidated list of all your order notes with the corresponding customer name and when the order notes were made.

![image](https://github.com/Subscribie/subscribie/assets/30567984/83d785da-c3a8-4940-b602-b0bedc7192ce)
2 changes: 1 addition & 1 deletion subscribie/blueprints/admin/export_transactions.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def export_transactions():
plan_title = transaction.subscription.plan.title
subscription_uuid = transaction.subscription.uuid
subscription_status = transaction.subscription.stripe_status
if transaction.subscription.note.note:
if transaction.subscription.note:
subscription_note = (
transaction.subscription.note.note.strip().replace(",", ";")
)
Expand Down
Loading