Mindbody · Schema

PurchaseContractResponse

Implementation of the 'PurchaseContractResponse' model. Response model for POST PurchaseContract endpoint

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
ClientId	string	The ID of the client who is purchasing the contract.
UniqueClientId	integer	The Unique ID of the client who is purchasing the contract.
LocationId	integer	The ID of the location where the contract is being purchased.
ContractId	integer	The ID of the general contract being purchased.
ClientContractId	integer	The ID of the specific contract being purchased by this specific client, not to be confused with the `ContractId`, which refers to a general contract that the business offers.
Totals	object	Purchase totals
PaymentProcessingFailures	array	Contains information only if SCA challenge is indicated.

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-purchase-contract-response-schema.json",
  "title": "PurchaseContractResponse",
  "description": "Implementation of the 'PurchaseContractResponse' model. Response model for POST PurchaseContract endpoint",
  "type": "object",
  "properties": {
    "ClientId": {
      "type": "string",
      "description": "The ID of the client who is purchasing the contract.",
      "example": "example-value"
    },
    "UniqueClientId": {
      "type": "integer",
      "format": "int32",
      "description": "The Unique ID of the client who is purchasing the contract.",
      "example": 123456
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where the contract is being purchased.",
      "example": 123456
    },
    "ContractId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the general contract being purchased.",
      "example": 123456
    },
    "ClientContractId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the specific contract being purchased by this specific client, not to be confused with the `ContractId`, which refers to a general contract that the business offers.",
      "example": 123456
    },
    "Totals": {
      "$ref": "#/components/schemas/PurchaseContractResponseTotals",
      "description": "Purchase totals"
    },
    "PaymentProcessingFailures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentProcessingFailure"
      },
      "description": "Contains information only if SCA challenge is indicated.",
      "example": [
        {}
      ]
    }
  }
}