Update a Wellness Plan

1 min

PUT

https://developer.digitail.io/api/v1/plans/{id}

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.

Body Parameters

bodyobject
- namestring
  Example
  Basic
- descriptionstring
  Example
  Basic subscription plan
- pricenumber
  Example
  20
- taxnumber
  Description
  Warning: Deprecated
  Deprecated. Use tax_rate_ids instead.
- tax_rate_idsinteger[]
  Example
```
[
  57
]
```
  Description
  Tax rate ids to apply. Takes precedence over tax when present. Send at most the clinic's max_tax_rates (1 today).
- upfront_feenumber
- periodicityinteger
  Example
  1
- periodicity_typestring<month | quarter | year>
  Allowed
  monthquarteryear
- statusstring<active | inactive>
  Example
  active
  Allowed
  activeinactive
- is_publicboolean
  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.
- plan_durationstring<indefinite | 1-year>
  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.
  Allowed
  indefinite1-year
- benefits_exclusionsobject
  - product_categoriesobject[]
    - product_category_idinteger
      Example
      12
- benefitsobject
  - servicesobject[]
    - idinteger
      Example
      1
    - service_package_idinteger
      Example
      1
    - limitinteger
      Example
      1
    - discountnumber
  - service_aaha_codesobject[]
    - idinteger
      Example
      1
    - aaha_codestring
      Example
      AHA123
    - discountnumber
    - limitinteger
      Example
      1
  - productsobject[]
    - idinteger
      Example
      1
    - product_idinteger
      Example
      1
    - limitinteger
      Example
      1
    - limit_unit_type_idinteger
    - limit_unit_typestring
      Example
      subunit
    - discountnumber
  - product_categoriesobject[]
    - idinteger
      Example
      1
    - product_category_idinteger
      Example
      1
    - discountnumber
  - product_aaha_codesobject[]
    - idinteger
      Example
      1
    - aaha_codestring
      Example
      AHA123
    - discountnumber
    - limitinteger
      Example
      1
    - limit_unit_type_idinteger

Responses

200successful operation

object
- dataobject
  - idinteger
    Example
    1
  - clinic_idinteger
    Example
    1
  - namestring
    Example
    Basic
  - descriptionstring
    Example
    Basic subscription plan
  - pricenumber
    Example
    10
  - price_without_taxnumber
    Example
    10
  - taxnumber
    Description
    Warning: Deprecated
    Deprecated. Summed percentage of tax_rates. Use tax_rates instead.
  - tax_rates0[]
    Description
    Tax rates applied to this item. Always present.
  - upfront_feenumber
  - upfront_fee_without_taxnumber
  - periodicityinteger
    Example
    1
  - periodicity_typestring<day | week | month | quarter | year>
    Allowed
    dayweekmonthquarteryear
  - statusstring<active | inactive>
    Example
    active
    Allowed
    activeinactive
  - is_publicboolean
  - plan_durationstring<indefinite | 1-year>
    Default
    indefinite
    Allowed
    indefinite1-year
  - benefitsbenefits
  - benefits_exclusionsobject
    - product_categoriesobject[]
      Description
      List of product categories excluded from global product discounts for this plan.
      - idinteger
        Example
        101
      - product_category_idinteger
        Example
        12

curl

curl --request PUT \
     --url https://developer.digitail.io/api/v1/plans/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/plans/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/plans/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/plans/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": {
    "id": 1,
    "clinic_id": 1,
    "name": "Basic",
    "description": "Basic subscription plan",
    "price": 10,
    "price_without_tax": 10,
    "tax": 0,
    "tax_rates": [
      ""
    ],
    "upfront_fee": 0,
    "upfront_fee_without_tax": 0,
    "periodicity": 1,
    "periodicity_type": "",
    "status": "active",
    "is_public": false,
    "plan_duration": "",
    "benefits": {},
    "benefits_exclusions": {
      "product_categories": [
        {
          "id": 101,
          "product_category_id": 12
        }
      ]
    }
  }
}