Mindbody · JSON Structure

Public Api V6 Client Purchase Record Structure

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

Type: object Properties: 9
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

ClientPurchaseRecord is a JSON Structure definition published by Mindbody, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Sale Description AccountPayment Price AmountPaid Discount Tax Returned Quantity

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-client-purchase-record-structure.json",
  "name": "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": "double",
      "description": "The price paid for the item.",
      "example": 49.99
    },
    "AmountPaid": {
      "type": "double",
      "description": "The amount paid for the item.",
      "example": 49.99
    },
    "Discount": {
      "type": "double",
      "description": "The discount amount that was applied to the item.",
      "example": 1.0
    },
    "Tax": {
      "type": "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": "int32",
      "description": "The quantity of the item purchased.",
      "example": 10
    }
  }
}