Mindbody · Schema

ClientPurchaseRecord

Implementation of the 'ClientPurchaseRecord' model. A record of a specific client purchase

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Sale	object	Contains details about the sale and payment for a purchase event.
Description	string	The item name and description.
AccountPayment	boolean	If `true`, the item was a payment credited to an account.
Price	number	The price paid for the item.
AmountPaid	number	The amount paid for the item.
Discount	number	The discount amount that was applied to the item.
Tax	number	The amount of tax that was applied to the item.
Returned	boolean	The return status of the item. If `true`, this item was returned.
Quantity	integer	The quantity of the item purchased.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-client-purchase-record-schema.json",
  "title": "ClientPurchaseRecord",
  "description": "Implementation of the 'ClientPurchaseRecord' model. A record of a specific client purchase",
  "type": "object",
  "properties": {
    "Sale": {
      "$ref": "#/components/schemas/Sale",
      "description": "Contains details about the sale and payment for a purchase event."
    },
    "Description": {
      "type": "string",
      "description": "The item name and description.",
      "example": "Example note for Mindbody Public API."
    },
    "AccountPayment": {
      "type": "boolean",
      "description": "If `true`, the item was a payment credited to an account.",
      "example": true
    },
    "Price": {
      "type": "number",
      "format": "double",
      "description": "The price paid for the item.",
      "example": 49.99
    },
    "AmountPaid": {
      "type": "number",
      "format": "double",
      "description": "The amount paid for the item.",
      "example": 49.99
    },
    "Discount": {
      "type": "number",
      "format": "double",
      "description": "The discount amount that was applied to the item.",
      "example": 1.0
    },
    "Tax": {
      "type": "number",
      "format": "double",
      "description": "The amount of tax that was applied to the item.",
      "example": 1.0
    },
    "Returned": {
      "type": "boolean",
      "description": "The return status of the item. If `true`, this item was returned.",
      "example": true
    },
    "Quantity": {
      "type": "integer",
      "format": "int32",
      "description": "The quantity of the item purchased.",
      "example": 10
    }
  }
}