Skip to main content
POST
/
pet-benefits
List Pet Benefits
curl --request POST \
  --url https://nestvet.com/api/1.1/wf/pet-benefits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": "<string>",
  "limit": 123,
  "offset": 123,
  "id": "<string>",
  "subscription_id": "<string>",
  "pet_id": "<string>",
  "clinic": "<string>",
  "created_at_since": "2023-11-07T05:31:56Z",
  "updated_at_since": "2023-11-07T05:31:56Z"
}
'
[
  {
    "id": "<string>",
    "pet": "<string>",
    "subscription": "<string>",
    "is_addon": true,
    "monthly_revenue_to_recognize_per_unit": 123,
    "annual_revenue_to_recognize_per_unit": 123,
    "revenue_to_recognize_per_unit": 123,
    "allocated": 123,
    "remaining": 123,
    "benefit_name": "<string>",
    "product_ids": [
      "<string>"
    ],
    "benefit_description": "<string>",
    "wellness_plan_name": "<string>",
    "retail_value": 123,
    "is_unlimited": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organization
string
required
limit
integer<int32>
required
offset
integer<int32>
required
id
string
subscription_id
string
pet_id
string
clinic
string

Optional filter; returns pet benefits within the provided clinic.

created_at_since
string<date-time>
updated_at_since
string<date-time>

Response

200 - application/json

A list of pet benefits

id
string
pet
string
subscription
string
is_addon
boolean
monthly_revenue_to_recognize_per_unit
number<double> | null
annual_revenue_to_recognize_per_unit
number<double> | null
revenue_to_recognize_per_unit
number<double>
allocated
integer
remaining
integer | null
benefit_name
string
product_ids
string[]
benefit_description
string
wellness_plan_name
string
retail_value
number<double>
is_unlimited
boolean
created_at
string<date-time>
updated_at
string<date-time>