Mindbody · Schema

GiftCard

Implementation of the 'GiftCard' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Id	integer	The gift card's `ProductID`.
LocationIds	array	The IDs of the locations where the gift card is sold.
Description	string	A description of the gift card.
EditableByConsumer	boolean	When `true`, indicates that the gift card can be edited by the client.
CardValue	number	The value of the gift card.
SalePrice	number	The sale price of the gift card, if applicable.
SoldOnline	boolean	When `true`, indicates that the gift card is sold online.
MembershipRestrictionIds	array	A list of IDs for membership restrictions, if this card is restricted to members with certain types of memberships.
GiftCardTerms	string	The terms of the gift card.
ContactInfo	string	Contact information for the gift card.
DisplayLogo	boolean	When `true`, indicates that the logo should be displayed on the gift card.
Layouts	array	A list of layouts available for the gift card.

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-gift-card-schema.json",
  "title": "GiftCard",
  "description": "Implementation of the 'GiftCard' model.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The gift card's `ProductID`.",
      "example": 123456
    },
    "LocationIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "The IDs of the locations where the gift card is sold.",
      "example": [
        1
      ]
    },
    "Description": {
      "type": "string",
      "description": "A description of the gift card.",
      "example": "Example note for Mindbody Public API."
    },
    "EditableByConsumer": {
      "type": "boolean",
      "description": "When `true`, indicates that the gift card can be edited by the client.",
      "example": true
    },
    "CardValue": {
      "type": "number",
      "format": "double",
      "description": "The value of the gift card.",
      "example": 1.0
    },
    "SalePrice": {
      "type": "number",
      "format": "double",
      "description": "The sale price of the gift card, if applicable.",
      "example": 49.99
    },
    "SoldOnline": {
      "type": "boolean",
      "description": "When `true`, indicates that the gift card is sold online.",
      "example": true
    },
    "MembershipRestrictionIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of IDs for membership restrictions, if this card is restricted to members with certain types of memberships.",
      "example": [
        1
      ]
    },
    "GiftCardTerms": {
      "type": "string",
      "description": "The terms of the gift card.",
      "example": "example-value"
    },
    "ContactInfo": {
      "type": "string",
      "description": "Contact information for the gift card.",
      "example": "example-value"
    },
    "DisplayLogo": {
      "type": "boolean",
      "description": "When `true`, indicates that the logo should be displayed on the gift card.",
      "example": true
    },
    "Layouts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GiftCardLayout"
      },
      "description": "A list of layouts available for the gift card.",
      "example": [
        {}
      ]
    }
  }
}