Execute checkout

post

https://app.officernd.com/api/v2/organizations/{orgSlug}/checkout

Execute a checkout for memberships, fees, or bookings. Provide either memberships/fees or a booking, but not both. This endpoint creates billable items and may trigger invoice generation, payment charging, email notifications, and legal document signing depending on the provided options and the organization's billing flow.

Memberships/Fees flow: Creates memberships and/or fees for the member. The checkout options control whether an invoice is generated immediately, whether the member is charged, and whether a credit card is required. If shouldRequestApproval is true, the order is created but payment is deferred and an approval request email is sent instead of the standard checkout confirmation.

Booking flow: Creates a booking for the specified resource and time slot. If the booking produces fees, an invoice is generated and processed automatically. This flow simulates the booking experience from the members portal or public calendar.

Required scopes: flex.billing.checkout.create

Path Params

orgSlug

string

required

organization slug

Query Params

enforceBookingPolicy

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

member

string

required

The _id of the member who is purchasing. Used to resolve the member's billing context, location, and company.

location

string

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

memberships

array of objects

Memberships to check out. Mutually exclusive with booking.

memberships

fees

array of objects

One-time fees to check out. Mutually exclusive with booking.

fees

booking

object

Booking to check out. Mutually exclusive with memberships/fees.

discountCode

string

A plan-level discount code. Applies the discount to all eligible plans in the order. Only one discount code is supported per checkout.

documents

array of strings

Legal document _ids to sign during checkout. Must be provided together with signatureMeta for document signing to occur.

documents

options

object

required

Controls the billing behavior for this checkout, including invoice generation, payment charging, and credit card requirements. These settings override the organization's default billing flow.

paymentProvider

object

Payment provider configuration for processing charges. Required when shouldChargeImmediatelly is true. Currently only Stripe is supported.

notifications

object

Controls which email notifications are sent after the checkout completes.

signatureMeta

string

Base64-encoded signature data used when signing the legal documents specified in documents. Both fields must be provided together for document signing to occur.

shouldRequestApproval

boolean

When true, the checkout creates the order but does not process payment. An approval request email is sent instead of the standard checkout confirmation. Payment validation is skipped in this mode.

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201