---
title: Update a Wellness Plan
slug: update-a-wellness-plan
docTags:
createdAt: 2026-09-28T12:33:18.310Z
---
{
"id": "piYkqY14C7lSrAud37VyN",
"type": "api-oas-v2",
"data": {
"method": "PUT",
"url": "https://developer.digitail.io/api/v1/plans/{id}",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/plans/{id}",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/plans/{id}",
"description": "Production server (uses live data)"
}
],
"name": "Update a Wellness Plan",
"description": "Update a Wellness Plan. Fields you leave out keep their current value, except tax, which is recomputed from tax_rate_ids when those are sent.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"schema": [
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Basic"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "Basic subscription plan"
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": "",
"example": 20
},
{
"name": "tax",
"kind": "optional",
"type": "number",
"deprecated": true,
"description": "Warning: Deprecated\nDeprecated. Use tax_rate_ids instead.
",
"example": 0
},
{
"name": "tax_rate_ids",
"kind": "optional",
"type": "array",
"description": "Tax rate ids to apply. Takes precedence over tax when present. Send at most the clinic's max_tax_rates (1 today).
",
"example": "[57]",
"itemType": "integer",
"customType": "integer[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "upfront_fee",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
},
{
"name": "periodicity",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "periodicity_type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"month",
"quarter",
"year"
]
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"example": "active",
"enum": [
"active",
"inactive"
]
},
{
"name": "is_public",
"kind": "optional",
"type": "boolean",
"description": "Shows the plan on the pet portal, the mobile app and GET /api/v1/public/clinics/{slug}/plans. Omit to keep the current value.
",
"example": false
},
{
"name": "plan_duration",
"kind": "optional",
"type": "string",
"description": "indefinite keeps subscriptions running until cancelled; 1-year ends each new subscription one year after it starts. Applies to new enrollments only. Omit to keep the current value.
",
"enum": [
"indefinite",
"1-year"
]
},
{
"name": "benefits_exclusions",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "product_categories",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "product_category_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 12
}
]
}
]
},
{
"name": "benefits",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "services",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "service_package_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "limit",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
}
]
},
{
"name": "service_aaha_codes",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "aaha_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "AHA123"
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
},
{
"name": "limit",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
}
]
},
{
"name": "products",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "product_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "limit",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "limit_unit_type_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 0
},
{
"name": "limit_unit_type",
"kind": "optional",
"type": "string",
"description": "",
"example": "subunit"
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
}
]
},
{
"name": "product_categories",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "product_category_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
}
]
},
{
"name": "product_aaha_codes",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "aaha_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "AHA123"
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
},
{
"name": "limit",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "limit_unit_type_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 0
}
]
}
]
}
],
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "passport",
"name": "passport",
"kind": "optional",
"type": "oauth2",
"description": "Laravel passport oauth2 security.",
"oauth2Flows": {
"authorizationCode": {
"authorizationUrl": "https://digitail.test/oauth/authorize",
"tokenUrl": "https://digitail.test/oauth/token",
"refreshUrl": "https://digitail.test/oauth/token"
}
}
},
{
"id": "Bearer",
"name": "Bearer",
"kind": "optional",
"type": "http",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "successful operation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Basic"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "Basic subscription plan"
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": "",
"example": 10
},
{
"name": "price_without_tax",
"kind": "optional",
"type": "number",
"description": "",
"example": 10
},
{
"name": "tax",
"kind": "optional",
"type": "number",
"deprecated": true,
"description": "Warning: Deprecated\nDeprecated. Summed percentage of tax_rates. Use tax_rates instead.
",
"example": 0
},
{
"name": "tax_rates",
"kind": "optional",
"type": "array",
"description": "Tax rates applied to this item. Always present.",
"modelRef": "#/paths/~1api~1v1~1tax-rates/get/responses/200/content/application~1json/schema/properties/data/items/allOf/0",
"customType": "0[]",
"schema": []
},
{
"name": "upfront_fee",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
},
{
"name": "upfront_fee_without_tax",
"kind": "optional",
"type": "number",
"description": "",
"example": 0
},
{
"name": "periodicity",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "periodicity_type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"example": "active",
"enum": [
"active",
"inactive"
]
},
{
"name": "is_public",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "plan_duration",
"kind": "optional",
"type": "string",
"description": "",
"default": "indefinite",
"enum": [
"indefinite",
"1-year"
]
},
{
"name": "benefits",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1plans~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/benefits",
"customType": "benefits",
"schema": []
},
{
"name": "benefits_exclusions",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "product_categories",
"kind": "optional",
"type": "array",
"description": "List of product categories excluded from global product discounts for this plan.",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 101
},
{
"name": "product_category_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 12
}
]
}
]
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "B-3o5re3z4jaRwyWMqDYO",
"language": "curl",
"label": "cURL",
"code": "curl --request PUT \\\n --url https://developer.digitail.io/api/v1/plans/{id} \\\n --header 'accept: application/json'"
},
{
"id": "ELKr4pCFj0buOI7K8nxSU",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/plans/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "wfjK__CFpTDDCRud3hs1x",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/plans/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "Uzj4oJPQKE5fXcHgIuxaY",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/plans/{id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "B-3o5re3z4jaRwyWMqDYO"
},
"results": {
"languages": [
{
"id": "QuJEushhog-ZyYdT48P2p",
"language": "200",
"code": "// successful operation\n{\n \"data\": {\n \"id\": 1,\n \"clinic_id\": 1,\n \"name\": \"Basic\",\n \"description\": \"Basic subscription plan\",\n \"price\": 10,\n \"price_without_tax\": 10,\n \"tax\": 0,\n \"tax_rates\": [\n \"\"\n ],\n \"upfront_fee\": 0,\n \"upfront_fee_without_tax\": 0,\n \"periodicity\": 1,\n \"periodicity_type\": \"\",\n \"status\": \"active\",\n \"is_public\": false,\n \"plan_duration\": \"\",\n \"benefits\": {},\n \"benefits_exclusions\": {\n \"product_categories\": [\n {\n \"id\": 101,\n \"product_category_id\": 12\n }\n ]\n }\n }\n}"
}
],
"selectedLanguageId": "QuJEushhog-ZyYdT48P2p"
}
},
"children": [
{
"text": ""
}
]
}