Mindbody · Schema

PromoCode

Implementation of the 'PromoCode' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
PromotionID	integer	ID of the promo code
Name	string	Name of the promo code
Code	string	The code of the promocode.
Active	boolean	Indicates that promocode is active.
Discount	object	Contains information about the discount.
ActivationDate	string	The promocode activation date.
ExpirationDate	string	The promocode expiration date.
MaxUses	integer	The maximun number of uses.
NumberOfAutopays	integer	Number of Autopays
DaysAfterCloseDate	integer	The number of days a client has to use a promocode after they are no longer a prospect.
AllowOnline	boolean	Indicates if promocode to be redeemed online in consumer mode.
LastModifiedDateTime	string	Promo code last modified date and time
DaysValid	array	What days the promo code can be used
ApplicableItems	array	Contains information about a promocode applicable items.

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-promo-code-schema.json",
  "title": "PromoCode",
  "description": "Implementation of the 'PromoCode' model.",
  "type": "object",
  "properties": {
    "PromotionID": {
      "type": "integer",
      "format": "int32",
      "description": "ID of the promo code",
      "example": 1
    },
    "Name": {
      "type": "string",
      "description": "Name of the promo code",
      "example": "Sunset Yoga Studio"
    },
    "Code": {
      "type": "string",
      "description": "The code of the promocode.",
      "example": "example-value"
    },
    "Active": {
      "type": "boolean",
      "description": "Indicates that promocode is active.",
      "example": true
    },
    "Discount": {
      "$ref": "#/components/schemas/Discount",
      "description": "Contains information about the discount."
    },
    "ActivationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The promocode activation date.",
      "example": "2026-05-28T14:30:00Z"
    },
    "ExpirationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The promocode expiration date.",
      "example": "2026-05-28T14:30:00Z"
    },
    "MaxUses": {
      "type": "integer",
      "format": "int32",
      "description": "The maximun number of uses.",
      "example": 1
    },
    "NumberOfAutopays": {
      "type": "integer",
      "format": "int32",
      "description": "Number of Autopays",
      "example": 1
    },
    "DaysAfterCloseDate": {
      "type": "integer",
      "format": "int32",
      "description": "The number of days a client has to use a promocode after they are no longer a prospect.",
      "example": 1
    },
    "AllowOnline": {
      "type": "boolean",
      "description": "Indicates if promocode to be redeemed online in consumer mode.",
      "example": true
    },
    "LastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Promo code last modified date and time",
      "example": "2026-05-28T14:30:00Z"
    },
    "DaysValid": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DaysValidEnum"
      },
      "description": "What days the promo code can be used",
      "example": [
        {}
      ]
    },
    "ApplicableItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApplicableItem"
      },
      "description": "Contains information about a promocode applicable items.",
      "example": [
        {}
      ]
    }
  }
}