addedInput schema / properties / coupon_code
Added value: +{
+ "description": "A coupon code the guest was given. Optional. When it applies, the link's signed total includes it and the link carries the code, so the website prices the stay the same way. A code that does not apply, or that nobody issued, leaves the price unchanged and is reported in coupon with its reason. A code tied to one guest's email is reported as not found. A quote does not reserve a use of a code, and the code is checked again when the guest books, so it may no longer apply then.",
+ "maxLength": 40,
+ "type": "string"
+}
changedOutput schema / properties / booking_url / description
Previous value: -"Where the guest completes the booking on Luxury Lodging's own site. The link a live quote returns for this stay and rate: the same home, dates, party, rate and attribution, with a freshly signed quote token (so its quote_ref differs from the quote's)."New value: +"Where the guest completes the booking on Luxury Lodging's own site. The link a live quote returns for this stay and rate: the same home, dates, party, rate, coupon and attribution, with a freshly signed quote token (so its quote_ref differs from the quote's). It names the coupon only when the coupon applied."
addedOutput schema / properties / coupon
Added value: +{
+ "description": "What happened to the coupon_code that was sent. Only returned when one was sent. The stay's totals already include the coupon when applied is true and are the price without it when applied is false.",
+ "properties": {
+ "amount_off": {
+ "description": "Dollars taken off the stay's rent. Only when applied is true; it is already inside the totals.",
+ "type": "number"
+ },
+ "applied": {
+ "description": "True when the code took money off this stay.",
+ "type": "boolean"
+ },
+ "code": {
+ "description": "The code as sent, in upper case.",
+ "type": "string"
+ },
+ "label": {
+ "description": "What the discount is called. Only when applied is true.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A sentence the guest can read about the code.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why the code did not apply. Only when applied is false. unknown: no such code. unavailable: the code could not be checked just now.",
+ "enum": [
+ "unknown",
+ "inactive",
+ "expired",
+ "not_started",
+ "wrong_market",
+ "wrong_home",
+ "requires_attribution",
+ "no_discountable_amount",
+ "outside_offer_window",
+ "blacked_out",
+ "minimum_nights",
+ "already_used",
+ "unavailable"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "applied",
+ "message"
+ ],
+ "type": "object"
+}