Get checkout cost preview

Returns a cost preview for a potential checkout without creating an order or charging the member. Provide either memberships/fees or a booking, but not both. A discount code can be included to see its effect on pricing.

Memberships/Fees flow: Calculates the order total based on the selected plans, fees, and the member's billing context (billing flow, currency, tax settings). Returns line items, subtotal, total, tax breakdown, and any applicable processing fees or discounts.

Booking flow: Returns a summary of the booking request including resource availability pricing, per-date fee breakdown with credits and coins applied, and the cancellation policy that would apply to the booking.

Required scopes: flex.billing.checkout.create

Path Params
string
required

organization slug

Query Params
boolean

Whether to enforce the booking policy and member validation rules when the request contains a booking. If true, member validations and booking-policy-driven tentative/approval flagging are applied to the booking checkout, and reflected in the checkout summary preview (note: policy-violation rejection is only applied at checkout, not in the summary preview). If false or not passed at all, the request behaves as it does today. Has no effect on memberships/fees checkouts.

Body Params
string
required

The _id of the member. Used to resolve the member's billing context including billing flow, currency, and company. Required for memberships/fees summaries.

string

Overrides the location for the order. If omitted, resolved from the member's assigned location.

memberships
array of objects

Memberships to include in the checkout summary. Mutually exclusive with booking.

memberships
fees
array of objects

Fees to include in the checkout summary. Mutually exclusive with booking.

fees
booking
object

Booking details for the checkout summary. Mutually exclusive with memberships/fees.

string

A discount code to apply to see its effect on pricing.

string

The card brand (e.g., "visa", "mastercard"). Used to calculate any card-specific processing fees in the summary.

string
enum

The payment method type. Used to calculate any method-specific processing fees in the summary.

Allowed:
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json