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()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/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()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/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()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice).

Alternatively you can customize the pricing logic using the
[Bookings Pricing Integration REST SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi).
If you integrate with a pricing provider, the customized pricing logic becomes
the default logic. This means that, if the Pricing Integration SPI is implemented,
when calling `calculatePrice()`,
the customized logic is used instead.

import { pricing } from 'wix-bookings.v2';

async function calculatePrice(booking) {
  try {
    const result = await pricing.calculatePrice(booking);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


calculatePrice example

import { pricing } from 'wix-bookings.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const calculatePrice = webMethod(
  Permissions.Anyone,
  async (booking) => {
    try {
      const result = await pricing.calculatePrice(booking);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


calculatePrice example for exporting from backend code

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
[Bookings Pricing Integration REST SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi). Calling `previewPrice` if custom pricing
logic has been implemented for the site results in an error.

import { pricing } from 'wix-bookings.v2';

async function previewPrice(bookingLineItems) {
  try {
    const result = await pricing.previewPrice(bookingLineItems);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


previewPrice example

import { pricing } from 'wix-bookings.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const previewPrice = webMethod(
  Permissions.Anyone,
  async (bookingLineItems) => {
    try {
      const result = await pricing.previewPrice(bookingLineItems);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


previewPrice example for exporting from backend code

previewPrice

PreviewPriceResponse

# About the Wix Bookings Pricing API

&nbsp; 
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>
&nbsp;

> **Note:** This module is [universal](/api-overview/api-versions#universal-modules).
> Functions in this module can run on both the backend and frontend,
> unless specified otherwise.


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

+ The [`previewPrice()`](wix-bookings-v2/pricing/previewprice) function 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.
+ The [`calculatePrice()`](wix-bookings-v2/pricing/calculateprice) function 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](wix-bookings-v2/service-options-and-variants) to set up more robust pricing options. 


## Terminology

For a comprehensive glossary of Wix Bookings terms, see [Terminology](wix-bookings-v2/terminology).


## Before You Begin


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

+ If using the 
  [Wix Bookings Pricing Provider REST SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi) to set up your own 
  custom logic for varied pricing, the [previewPrice()](wix-bookings-v2/pricing/previewprice) function is not supported and an error is issued.

+ To use the Bookings Pricing API, import `{ pricing }` from the `wix-bookings.v2` module in your Velo code:

    ```javascript
    import { pricing } from 'wix-bookings.v2';
    ```

velo-deps_wix-bookings.v2_pricing

Actor

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.

BookingSource

Actor that created this booking.

actor

Wix site ID of the application that created the booking.

appDefId

Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.

appName

Platform from which a booking was created

platform

Platform

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

namespaces

FlowControlSettings

When true, skips availability checking and allows booking.
Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.

skipAvailabilityValidation

When true, allows booking a confirmation-required service without requiring confirmation.
Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.

skipBusinessConfirmation

When true, skips selected payment option checking as defined in `selectedPaymentOption` field
and allows booking.
Requires BOOKINGS.MANAGE_PAYMENTS permissions.

skipSelectedPaymentOptionValidation

When true, refunds the booking's payment when the booking is canceled.

withRefund

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.

IdentityType

Business location ID. Available only for locations that are business locations,
meaning the `location_type` is `"OWNER_BUSINESS"`.

Location type.

- `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings.
- `"OWNER_CUSTOM"`: The address as set when creating the service.
- `"CUSTOM"`: The address as set for the individual session.

locationType

LocationType

MultiServiceBookingInfo

type

MultiServiceBookingType

ParticipantChoices

Information about the booked service choices. Includes the number of participants.

serviceChoices

ParticipantNotification

Custom message to send to the participants about the changes to the booking.

message

Whether to send the message about the changes to the customer.

Default: `false`

calculatePrice( )

Calculating the price

Permission Scopes