pet-benefits
Get one pet benefit
POST
/
pet-benefits
/
get
Get one pet benefit
curl --request POST \
--url https://practice-data.nest.vet/api/v3/pet-benefits/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"organization": "<string>"
}
'import requests
url = "https://practice-data.nest.vet/api/v3/pet-benefits/get"
payload = {
"id": "<string>",
"organization": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '<string>', organization: '<string>'})
};
fetch('https://practice-data.nest.vet/api/v3/pet-benefits/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://practice-data.nest.vet/api/v3/pet-benefits/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'organization' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://practice-data.nest.vet/api/v3/pet-benefits/get"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://practice-data.nest.vet/api/v3/pet-benefits/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://practice-data.nest.vet/api/v3/pet-benefits/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"pet": "<string>",
"subscription": "<string>",
"benefit_name": "<string>",
"benefit_description": "<string>",
"wellness_plan_name": "<string>",
"is_addon": true,
"revenue_to_recognize_per_unit": 123,
"retail_value": 123,
"provided": 123,
"remaining": 123,
"is_unlimited": true,
"rounding_addition": 123,
"is_perk": true,
"in_kind_discount": 123,
"parent_petbenefit": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inactivation_date": "2023-11-07T05:31:56Z",
"activation_date": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<unknown>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}Authorizations
Authorization: Bearer <api key>. The key resolves to your organization; every response is scoped to it. An organization field in the request body is optional, but if present it must match, or the request is rejected.
Body
application/json
Response
One pet benefit.
removed/is_deleted is a business/lifecycle attribute, not a soft-delete flag -- pet benefits have no soft-delete concept.
⌘I
Get one pet benefit
curl --request POST \
--url https://practice-data.nest.vet/api/v3/pet-benefits/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"organization": "<string>"
}
'import requests
url = "https://practice-data.nest.vet/api/v3/pet-benefits/get"
payload = {
"id": "<string>",
"organization": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '<string>', organization: '<string>'})
};
fetch('https://practice-data.nest.vet/api/v3/pet-benefits/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://practice-data.nest.vet/api/v3/pet-benefits/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'organization' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://practice-data.nest.vet/api/v3/pet-benefits/get"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://practice-data.nest.vet/api/v3/pet-benefits/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://practice-data.nest.vet/api/v3/pet-benefits/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"organization\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"pet": "<string>",
"subscription": "<string>",
"benefit_name": "<string>",
"benefit_description": "<string>",
"wellness_plan_name": "<string>",
"is_addon": true,
"revenue_to_recognize_per_unit": 123,
"retail_value": 123,
"provided": 123,
"remaining": 123,
"is_unlimited": true,
"rounding_addition": 123,
"is_perk": true,
"in_kind_discount": 123,
"parent_petbenefit": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inactivation_date": "2023-11-07T05:31:56Z",
"activation_date": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<unknown>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}