Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

booking

Booking

Calculates the base price of a booking.



You can call `calculatePrice()` after a booking is created. The returned calculated price includes information about each line
item's price and the booking's total price.

You can use `previewPrice()` to get the base price
before a booking is created.

The calculated price is the base price that will be used as a basis for charging the customer.
During checkout, additional taxes
and fees might be added to this base price.

## Calculating the price

Wix Bookings has its own default pricing logic for calculating the price. When
using Wix Bookings' default pricing logic, you must pass the `serviceId` in the `slot`
or `schedule` object to `calculatePrice()`.

Alternatively you can customize the pricing logic using the
[BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin.
If you integrate with a pricing provider, the customized pricing logic becomes
the default logic. This means that, if the Custom Pricing service plugin is implemented,
when calling `calculatePrice()`,
the customized logic is used instead.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function calculatePrice(booking) {
  const response = await wixClient.pricing.calculatePrice(booking);
}

calculatePrice() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function calculatePrice(booking) {
  const response = await wixClient.pricing.calculatePrice(booking);
}

calculatePrice() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function calculatePrice(booking) {
  const response = await wixClient.pricing.calculatePrice(booking);
}

calculatePrice() with Dashboard app access

calculatePrice

CalculatePriceResponse

List of line items to preview the price for.

bookingLineItems

Previews the base price for a set of line items belonging to the same service
before a potential booking is actually created.



The returned price preview information about each line
item's price and sums up each line item's price.

The previewed price is not the actual price that will be used to charge the customer.
`Preview Price` only estimates the base price by adding up the price
of each line item before
the booking is actually created.

Use [`Calculate Price`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice) to get the base price
after the booking is created.

Passing line items that belong to different services results in an error.

## Calculating the previewed price

Wix Bookings has its own default pricing logic for previewing the price. You must
pass the `serviceId` in the `slot`
or `schedule` object to `previewPrice()`.

You cannot call `previewPrice()` if you have customized Bookings pricing logic using the
[BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin. Calling `previewPrice` if custom pricing
logic has been implemented for the site results in an error.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function previewPrice(bookingLineItems) {
  const response = await wixClient.pricing.previewPrice(bookingLineItems);
}

previewPrice() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function previewPrice(bookingLineItems) {
  const response = await wixClient.pricing.previewPrice(bookingLineItems);
}

previewPrice() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { pricing } from '@wix/bookings';

const wixClient = createClient({
  modules: { pricing },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function previewPrice(bookingLineItems) {
  const response = await wixClient.pricing.previewPrice(bookingLineItems);
}

previewPrice() with Dashboard app access

previewPrice

PreviewPriceResponse

---
title: Introduction
---

# Introduction

With the Wix Bookings Pricing API, you can preview and calculate the 
price of a booking. 

+ [`previewPrice()`](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/preview-price) lets you retrieve information about how much a customer would have to pay for a booking's line items before the actual booking has been created.
+ [`calculatePrice()`](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) determines the base price of a booking.  

The price of the booking can be fixed, free, or varied. With [varied pricing](https://support.wix.com/en/article/wix-bookings-creating-a-course#step-2-set-the-price-and-payment-options-for-the-course), site owners can offer different prices for the same service based on their customers' choices. 
+ Site owners can set up basic varied pricing options in the site's dashboard. 
+ You can use the [Wix Bookings Service Options and Variants APIs](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) to set up more robust pricing options. 

## Terminology

For a comprehensive glossary of Wix Bookings terms, see [Terminology](https://dev.wix.com/docs/sdk/backend-modules/bookings/terminology).  

## Before You Begin  

It’s important to note the following points before starting to code:  

+ You can only preview the price for line items belonging to the same 
  service.

+ If using the 
  [Wix Bookings Pricing Integration service plugin](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/calculate-price) to set up your own custom logic for varied pricing, then [`previewPrice()`](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/preview-price) is not supported and an error is issued.


To use the Pricing API, install the `@wix/bookings` package using npm or Yarn:
  ```console
npm install @wix/bookings
```

or

```console
yarn add @wix/bookings
```

Then import `{ pricing }` from `@wix/bookings`:

```js
import { pricing } from '@wix/bookings'
```
  

bookings_pricing

Address

Main address line, usually street and number, as free text.

addressLine

Street name, number and apartment number.

streetAddress

Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.

addressLine2

string

city

country

countryFullname

A string containing the full address of this location.

formattedAddress

geocode

AddressLocation

hint

postalCode

Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).

subdivision

Multi-level subdivisions from top to bottom.

subdivisions

latitude

number

longitude

BookedEntity

The booked schedule. The booking is automatically assigned to the schedule's sessions.

schedule

The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist.

slot

List of tags for the booking.
System-assigned tags for sessions and schedules are:
+ "INDIVIDUAL" Appointments, including appointments with more than 1 participant.
+ "GROUP" Individual classes.
+ "COURSE" Courses.

title

BookedResource

email

name

scheduleId

BookedSchedule

The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format. Required.

firstSessionStart

The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format. Required.

lastSessionEnd

Location where the schedule's sessions take place. Read only.

location

Location

serviceId

The timezone according to which the slot was shown to the user when booking, and should be shown in future.

timezone

BookedSlot

The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format.

endDate

Calendar 3 event ID
If not empty, on all write flows (create / update) gets priority over session_id.
so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.
Otherwise, if event_id is empty on write flow,

eventId

Location where the slot's session takes place.

The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.
When populated, the given resource will be booked according to it's availability.
When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,
otherwise one of the service resources will be assigned to the slot randomly upon confirmation.
This resource is the slot primary resource.

resource

ID of the underlying session when session is a single session or generated from a recurring session.
If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.

sessionId

The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format.

startDate

Information about the booked service choices and participants.
Available only when the booking includes multiple service variants.

participantsChoices

Total number of participants. Available only when the booking includes a single service variant.

totalParticipants

_createdDate

_updatedDate

Additional custom fields submitted with the booking form.

additionalFields

An object describing the slot or schedule that was booked.

bookedEntity

Contact details of the site visitor or member making the booking.

contactDetails

ContactDetails

ID of the creator of the Booking.
If `appId` and another ID are present, the other ID takes precedence.

createdBy

IdentificationData

Whether this booking overlaps another existing confirmed booking. Returned when: `true`

doubleBooked

boolean

The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.

Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.

extendedFields

ExtendedFields

External ID provided by the client app on creation.

externalUserId

Payment status.
One of:
- `"NOT_PAID"` The booking is not paid for.
- `"PAID"` The booking is fully paid.
- `"PARTIALLY_PAID"` The booking is partially paid.
- `"REFUNDED"` The booking is refunded.
- `"EXEMPT"` The booking is free of charge.

paymentStatus

PaymentStatus

Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking.

revision

Selected payment option.

Supported values: `"OFFLINE"`, `"ONLINE"`, `"MEMBERSHIP"`, `"MEMBERSHIP_OFFLINE"`.

One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.
When undefined, the payment option is resolved by the service configuration on checkout.

selectedPaymentOption

SelectedPaymentOption

The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.

Booking status.
One of:
- `"CREATED"` - The booking was created.
- `"UPDATED"` - The booking was updated.
- `"CONFIRMED"` - The booking was confirmed and appears on the bookings calendar. A booking can be manually confirmed using the [`confirmOrDecline()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/confirmordeclinebooking) API. A booking can be automatically confirmed when the following requirements are met:
    + The service is configured as automatically confirmed.
    + The system invoked the eCommerce checkout API and created an order.
- `"CANCELED"` - The booking has been canceled and synced to the bookings calendar.
The booking can be canceled using [`cancelBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/cancelbooking) API.
- `"PENDING"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.
Bookings can be manually set as `PENDING` using the `setAsPending()` API, by those with Manage Booking Status permissions scopes.
Bookings can be automatically set as `PENDING` when the following requirements are met:
    + The service is configured as manually confirmed.
    + Invoking the eCommerce checkout API and an order has been created.
- `"WAITING_LIST"` - The booking is on a waiting list.
- `"DECLINED"` - The booking was declined by the owner and synced to the Bookings calendar. Bookings can be manually declined using the [`declineBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/declinebooking) API by those with Manage Booking Status permission scopes. Bookings can be automatically declined when one of the following requirements are met:
    + Invoking the `eCommerce checkout` API and the order declined event has been sent.
    + Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking.

status

BookingStatus

BookingLineItem

Custom choices. Choices are specific values for an option the customer can choose to book.
For example, the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
Each choice may have a different price.

choices

Number of participants for the line item.

numberOfParticipants

pricePerParticipant

Resource ID. Required for services of type appointment or class.

resourceId

Service ID.

Required when not using Wix Booking's default pricing logic.

Information about each line item's price and the actual total base price.

priceInfo

PriceInfo

contactId

Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

countryCode

Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet).

Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field.

firstName

fullAddress

lastName

phone

timeZone

CustomFormField

ID of the form field as defined in the form.

Form field's label at the time of submission.

label

value

Form field value's type at the time of submission.

Supported values: `"SHORT_TEXT"`, `"LONG_TEXT"`, `"CHECK_BOX"`

valueType

ValueType

Data Extensions extended fields expressed as a set of key-value pairs:

`key:value`

+ `key` is the namespace, type `string`.
+ `value` is the data of the extended fields data, type `struct`.