Skip to main content
GET
Suggest an adoption fee

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

animal_id
string

An animal's record ID.

species
enum<string>

Without animal_id: the species of an animal not yet saved.

Available options:
dog,
cat,
rabbit,
equine,
small_mammal,
large_mammal,
bird,
barnyard,
fish,
reptile,
exotic
dob_estimate
string<date>

Without animal_id: its date of birth, or the best estimate. Leave it out when unknown.

animals
integer

With animal_id: how many animals are going home together, for a discount that needs several. Wins over application_id.

Required range: 1 <= x <= 10
application_id
string

With animal_id: an application whose animals are going home together. Its number of animals is used.

Response

The suggestion.

suggestion
object | null
required

The first active rule that matches, or null when none does.

age_band
string
required

The age group the animal is in, or unknown.

species
string
required
current_fee_cents
integer | null
required

The animal's fee now. Null when it has none, or when the animal is not yet saved.

list_cents
integer | null
required

What the discounts came off: the matched rule's amount, else the current fee. Null when there is neither.

discounts
object[]
required

The discounts that applied, in order. One that took nothing off is not listed.

net_cents
integer | null
required

The fee after discounts. Null when list_cents is null.