Skip to content
Open

FAQ #1289

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
2 changes: 2 additions & 0 deletions documentation/api-reference/introduction-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ JSON is returned by all API responses, including errors. However, Voucherify API

To make the API as explorable as possible, this documentation has a test mode. You can test all methods at no cost. Click **Try it** in an endpoint page to open a playground and configure your request.

An API call is a single request sent to the Voucherify API to process, save, or fetch data. For example, when a customer redeems a discount coupon, the redemption request counts as one API call. API calls are counted against your project limits. If you exceed your hourly or monthly quota in a production project, your campaigns may be blocked. You can check current API usage in **Project settings** > **API Usage**. To increase API call limits, upgrade your pricing plan or buy an API call package.

Fields that are necessary in the request are marked as `required`. Fields that will always be returned in the response are also marked as `required`.

In general the API consists of 3 sets:
Expand Down
2 changes: 2 additions & 0 deletions documentation/build/create-discount-coupons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Vouchers that are already *published or redeemed keep their existing settings*.
To change their settings, update the voucher directly.
</Warning>

After creating vouchers, you can view different code formats in the campaign **Vouchers** tab. Open a voucher to view its details and access the text code, QR code, or barcode format.

<Calendar/>

## Related features
Expand Down
2 changes: 1 addition & 1 deletion documentation/build/create-referral-campaign.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Go to **Campaign hub** > **Campaigns** to **Create campaign** and select **Refer

Next, define campaign size:
- Set **Code count** to define how many referral codes are generated when the campaign is created.
- Enable **Auto-increase voucher count** to automatically generate new referral codes when the initial pool is exhausted.
- Enable **Auto-increase voucher count** to automatically generate new referral codes when the initial code pool is exhausted during publication.

<CodeSettings/>

Expand Down
2 changes: 1 addition & 1 deletion documentation/build/earning-rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This step defines the reward value, timing, and expiration rules for the points
* **Pending points**: You can set a delay time before customers can actually use the earned points.
- You can set a specific pending period in days.
- Points are added to the customer's account immediately but remain in a pending state. Once the set number of days has passed, the points are automatically made available to the customer.
* **Expiration rules**: Configuration defining when the points acquired through this specific earning rule will expire. If an earning rule doesn't have its own expiration rule, the campaign-level point expiration will be used instead.
* **Expiration rules**: Configuration defining when the points acquired through this specific earning rule will expire. You can set different point expiration rules for individual earning rules. If an earning rule doesn't have its own expiration rule, the campaign-level point expiration will be used instead.

### Validation rules (optional)

Expand Down
10 changes: 9 additions & 1 deletion documentation/build/loyalty-campaign-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,17 @@ The following concepts are key for understanding the loyalty engine.
</Accordion>

<Accordion title="Earning rule">
Defines the action(s) that assign a specific number of loyalty points to a customer's card. Each earning rule has a specific timeframe determining when it is active.
Defines the action that assigns loyalty points to a customer's card. Each earning rule has a specific timeframe determining when it is active.

Earning rules can be based on orders, custom events, or customers entering segments. For order-based earning rules, points can be calculated proportionally to the order value. For custom events and segment-based earning rules, points are assigned as a fixed value.

A project can have up to 100 loyalty earning rules. This limit can be increased for single-tenant setups.
</Accordion>

<Accordion title="Loyalty tier">
Levels of membership within your program. A tier is defined by a minimum and maximum point range on a customer's card. You can map different rewards and earning rules to specific tiers.

There is no limit on the number of tiers you can create in a loyalty program. However, too many tiers can make the program harder for customers to understand.
</Accordion>

<Accordion title="Reward">
Expand All @@ -49,6 +55,8 @@ The following concepts are key for understanding the loyalty engine.

<Accordion title="Auto-join campaign">
An optional mode where customers are automatically assigned a loyalty card when they meet an earning rule, provided they don't already have one.

Customers can join automatically after actions such as placing an order that meets defined conditions, entering a customer segment, or performing a custom event.
</Accordion>

<Accordion title="Join-once campaign">
Expand Down
2 changes: 1 addition & 1 deletion documentation/build/loyalty-points.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To change the balance, go to a loyalty card's view and select the add points ico

</Info>

You can transfer loyalty points between loyalty cards, including between loyalty cards in different loyalty programs.
You can transfer loyalty points between loyalty cards assigned to the same customer or different customers. The cards can belong to the same loyalty program or different loyalty programs.

When you transfer points from one card to another, the expiration date is reset for the transferred points on the transfer day. For example, if the transfer occurs on 25th January and the expiration is set to 1 month, the points will expire on 25th February after the transfer.

Expand Down
20 changes: 16 additions & 4 deletions documentation/build/referral-campaign-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,28 +46,40 @@ The following concepts are key for understanding the referral program.
A conversion event is the specific action that triggers a successful referral in Voucherify. Each campaign can only have one primary conversion event: code redemption or custom event.
</Accordion>

<Accordion title="Referral tier">
<Accordion title="Referral tier">
A reward level that defines when and how a referrer is rewarded. Tiers enable milestone-based and multi-level referral programs.

There are two criteria for rewarding the referrer:
- Each unique referee redemption
- Minimum unique referee redemptions

By setting referral tiers, referrers can receive better rewards when they refer, for example, more than 20 people, and even more rewards when they refer more than 50.

To disable a reward for a given tier, mark the reward as **Not available** in the reward mapping.
</Accordion>

<Accordion title="Reward">
An incentive issued to referrers and, in double-sided programs, to referees. Rewards can include discounts, gift credits, or loyalty points.
An incentive issued to referrers and, in double-sided programs, to referees.

Referrer rewards can include discount coupons, gift card credits, loyalty points, or material rewards based on products. Referrers can be rewarded after each successful referral action or after a defined number of successful referrals.

Use referral tiers to offer different rewards or different reward criteria in the same referral campaign. For example, one tier can reward a referrer after one successful referral with a $5 discount, and another tier can reward a referrer after two successful referrals with a 20% discount.
</Accordion>

<Accordion title="Referral code publication">
The assignment of a referral code to a specific customer. Codes must be published before a customer can start referring others.
The assignment of a referral code to one or more customers. Codes must be published before customers can start referring others.

Optionally, codes can also be shared by non-referrers, allowing multiple people to distribute the same code.
You can assign the same referral code to multiple customers. In the Dashboard, open a referral program, go to the **Referral codes** tab, select a code, and share it with additional customers from the referral code details.

You can also assign one referral code to many customers with the [Add Referral Code Holders](/api-reference/referrals/add-referral-code-holders) API endpoint.

Customers who are assigned as referral code holders can see the referral code through the Qualification API.
</Accordion>

<Accordion title="Join-once campaign">
A setting for referral programs that ensures a customer can hold only one **referral code** per campaign. Once set, this can't be toggled off in the **Dashboard**.

If the same customer requests another referral code from the same campaign, Voucherify returns the existing code instead of generating a new one.
</Accordion>

<Accordion title="Auto-update campaign">
Expand Down
4 changes: 3 additions & 1 deletion documentation/discover/dashboard-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ If you upgrade from trial to a paid plan, Sandbox will be visible in your projec

Once logged in, Voucherify will lead you through a marketer onboarding tour. As part of the tour, you can create your first campaign and set up additional rules to fine tune your promotion activity.

If you don't want to follow the onboarding tour, you can skip it any time.
If you don't want to follow the onboarding tour, you can skip it any time.

As you move through the Dashboard, you can lock the navigation sidebar to keep it expanded across all views. Use the lock button in the top-right corner of the sidebar to toggle between locked and unlocked states. When unlocked, the sidebar can collapse dynamically depending on the layout or screen size.

Alternatively, you can create your first campaign with the tutorial below.

Expand Down
10 changes: 8 additions & 2 deletions documentation/get-started/integration-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Consider these key points in your planning:

- **Team access**: Invite as [many users](/manage/members-and-roles) as needed and assign role-based access to keep responsibilities clear and data secure. Generate separate API keys if needed to manage integrations by scope.

- **API touchpoints**: Map out your customer journey to decide where incentives will appear and how they’ll be redeemed. Identify if you need [qualification](/guides/checking-eligibility), [validation](/api-reference/validations/validate-stackable-discounts), or [redemption](/api-reference/redemptions/rollback-stackable-redemptions) steps and where each fits in the flow. Then, pinpoint which systems (e.g. e-commerce, mobile app, POS) should connect with Voucherify to handle these calls.
- **API touchpoints**: Map out your customer journey to decide where incentives will appear and how they’ll be redeemed. Identify if you need [qualification](/guides/checking-eligibility), [validation](/api-reference/validations/validate-stackable-discounts), or [redemption](/api-reference/redemptions/redeem-stackable-discounts) steps and where each fits in the flow. Then, pinpoint which systems, such as e-commerce platforms, mobile apps, or POS systems, should connect with Voucherify to handle these calls. For offline stores, POS integrations can use Voucherify API endpoints to validate and redeem codes at checkout.

- **Data model**: Define what kind of data you need and prepare them beforehand.

Expand Down Expand Up @@ -208,8 +208,14 @@ You can use the following functionalities to track and maintain your Voucherify

- Explore the [Voucherify Postman Collection](https://www.postman.com/voucherify/voucherify-s-public-workspace/) to check API requests and responses.

- Join [Voucherify Community Slack](https://www.voucherify.io/community) to get help and inspiration.
- Read the [Voucherify release notes](/changelog/changelog) to learn about new features and product updates.

- Visit the [Voucherify roadmap](https://roadmap.voucherify.io/) to find out what Voucherify developers are currently working on or suggest improvements and vote for features you want to see in the platform.

- Sign up for product updates in **My profile** > **Email Preferences**.

- Visit the [Voucherify blog](https://www.voucherify.io/blog) for product updates, guides, and use cases.

- Get support through [Voucherify Community Slack](https://www.voucherify.io/community), email, phone calls, or online consultations. Available support options depend on your pricing plan. Premium Support and Extended Premium Support are available for Enterprise plans. Contact [Voucherify sales](https://www.voucherify.io/contact-sales) to learn more.

- Contact [Voucherify support](https://www.voucherify.io/contact-support) if you have any further questions.
4 changes: 3 additions & 1 deletion documentation/get-started/key-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,10 @@ Redemptions work together with other Voucherify entities, see examples in the ta

A rollback reverts a redemption. It withdraws the incentive from the customer's order and updates its status.

You can roll back a redemption from the redemption details screen in the Dashboard or with the [Rollback stackable discounts](/api-reference/redemptions/rollback-stackable-redemptions) API endpoint.

<Note>
[Rollback stackable discounts](/api-reference/redemptions/rollback-stackable-redemptions) API reference
You can roll back redemptions up to 3 months after the original redemption.
</Note>

## Communication
Expand Down
4 changes: 3 additions & 1 deletion documentation/integrations/distributions-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,13 @@ Some integrations do not send messages directly to customers. Voucherify transfe

## Limits and anti-spam policy

To send messages through Voucherify, your account must follow the Voucherify [anti-spam policy](https://www.voucherify.io/legal/anti-spam-policy-v1-1):
Trial accounts have message limits to prevent spam and ensure compliance with anti-spam regulations. To send messages through Voucherify, your account must follow the Voucherify [anti-spam policy](https://www.voucherify.io/legal/anti-spam-policy-v1-1):
- Trial accounts are limited to 10 total messages before verification.
- Verified trial accounts can send up to 10 messages per day and 100 per month.
- Email sending requires **Brand Details** in [Project settings](/manage/project-settings).

To request higher messaging limits during the trial, complete your company details in **Project settings** > **Brand details** and contact [Voucherify support](https://www.voucherify.io/contact-support). Voucherify may ask you to describe how you plan to use distributions, including who will receive messages and what content you plan to send.

Large-scale distributions are governed by the Voucherify [Fair use policy](https://www.voucherify.io/legal/fair-use-policy-v2-3).

## Create distribution
Expand Down
6 changes: 6 additions & 0 deletions documentation/manage/account-security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,12 @@ Most account-level notifications support **in-app and email delivery**. Some not
Account-level notifications are informational. They do not block API calls or user access.
</Note>

### Downtime notifications

To receive updates about Voucherify service availability, subscribe to email alerts on the [Voucherify status page](https://status.voucherify.io/).

Status page alerts notify you about incidents, maintenance, and service disruptions.

## Related features

Account security can be combined with the following features.
Expand Down
8 changes: 7 additions & 1 deletion documentation/manage/project-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The **General** tab contains the main configuration for your project.
This section shows basic information about the project:
- **Application name**: The name of your Voucherify project.
- **Time zone**: The default time zone used for dates and expiration rules.
- **Currency**: The currency shown in the dashboard. After changing the project currency, log out and log in again to apply the change.
- **Currency**: The currency shown in the dashboard. Currency is set per project, so you can use separate projects for different currencies. Changing the currency affects how values are displayed in the dashboard, but it doesn't affect how Voucherify API calculates discounts and amounts because the API is currency-agnostic. If you need to handle multiple currencies in one campaign, you can model currency-specific discount values with dynamic discount formulas. After changing the project currency, log out and log in again to apply the change.
- **Locale**: Select one of the available locale options. The selected locale automatically sets the date format and the first day of the week (for example, Monday, Saturday, or Sunday).
- **Advanced code settings**: The default character set used to generate voucher codes.
- **Default international dialing prefix**: Used when a customer is added without a phone prefix.
Expand All @@ -30,6 +30,12 @@ This section shows basic information about the project:
</Warning>
- **API endpoint**: The base URL for API requests assigned when selecting the project region. It can't be edited.

<Note>
Voucher codes can use letters, numbers, and special characters. To keep codes easy to read, avoid commonly confused characters, such as `0` and `O`, and uncommon special characters.

Metadata property names can use uppercase and lowercase letters, numbers, hyphens (`-`), and underscores (`_`).
</Note>

### Project members

The **Project members** section lists all users assigned to the project, along with their roles and access status.
Expand Down
22 changes: 21 additions & 1 deletion documentation/manage/team-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Data is not shared between projects. Each project has separate customers, campai

<Info>

You can add as many projects as your subscription limit allows. The Sandbox project is not counted towards the project limit.
There is no limit on the number of campaigns you can run in a single project. You can add as many projects as your subscription limit allows. The Sandbox project is not counted towards the project limit.

</Info>

Expand Down Expand Up @@ -144,6 +144,26 @@ Create a new project with **Create project**.

Once you complete these steps, the project is ready for further configuration.

### Delete a project

Delete a project from **Team settings** using the project actions menu.

<Steps>
<Step title="Open project actions">
Go to **Team settings** and find the project you want to delete.

Click the tricolon menu (`⁝`) next to the project name.
</Step>

<Step title="Delete the project">
Click **Delete** and confirm the action.
</Step>
</Steps>

<Warning>
Deleting a project permanently removes its configuration and data.
</Warning>

## Roles

In the **Roles** tab, you can review role permissions for the built-in roles. You can also create and manage custom roles (enterprise feature).
Expand Down
4 changes: 3 additions & 1 deletion documentation/manage/voucherify-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@ Once you upgrade to a paid plan, the Sandbox project remains available and it do
To keep using Voucherify after the trial ends, you need to create a paid subscription:
1. Go to **Team settings** > **Subscription**.
2. Click **Create subscription** and choose a plan.
3. Enter billing information and credit card details.
3. Enter billing information and credit card details. Voucherify accepts Visa, Mastercard, Maestro, Discover, and American Express.
4. Click **Create**.

Your billing cycle starts on the day you confirm the subscription.

Enterprise subscriptions can also be paid by wire transfer.

### Update your pricing plan

If your needs change, you can upgrade your plan at any time from the subscription settings:
Expand Down
Loading
Loading