Get Contracts
get_contractsGet Contracts — GET /sale/contracts Mindbody calls: 1.
Returns the contracts and autopay options that are available on a location-by-location basis. Depending on the configurations established by the site, this endpoint returns options that can be used to sign up clients for recurring payments for services offered by the business.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of results to include, defaults to 100 | |
| offset | No | Page offset, defaults to 0. | |
| siteId | No | Site to call (SiteId header). Default -99. | |
| promoCode | No | PromoCode to apply | |
| locationId | Yes | The ID of the location that has the requested contracts and AutoPay options. | |
| soldOnline | No | When `true`, the response only contains details about contracts and AutoPay options that can be sold online. When `false`, all contracts are returned. Default: false | |
| contractIds | No | When included, the response only contains details about the specified contract IDs. | |
| uniqueClientId | No | The ID of the client. |