Rivier/ Reference/ bookings

Add a rate plan, optionally derived from another

post/lodging/rate-plans

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:admin
Mcp
rivier_lodging_rate_plan_create
Sdk
bookings.ratePlan.create
Cli
bookings rate plan create

Request bodyapplication/json, required

  • propertyIdstring (uuid)required
  • codestringrequired
    Pattern: ^[A-Za-z0-9_-]{1,24}$.
  • namestringrequired
    At most 120 characters.
  • parentIdstring (uuid) or null
  • adjustmentobject or null
  • mealPlanstring
    One of: room_only, breakfast, half_board, full_board, all_inclusive. Default: room_only.
  • cancellationPolicyIdstring (uuid) or null
  • depositobject
    Default: {"kind":"none"}.
  • guaranteestring
    One of: none, deposit, card, prepaid. Default: none.
  • channelslist of string
    Default: ["direct"].
  • kindstring
    One of: standard, non_refundable, package, long_stay. Default: standard.
  • contentobject
    Default: {}.
  • includedExtraslist of string (uuid)
    Default: [].
  • paymentSchedulelist of object
    Default: [].
    • whenstringrequired
      One of: booking, days_before_arrival, arrival.
    • daysinteger
      At least 1. At most 365.
    • percentnumberrequired
      At least 1. At most 100.
  • minNightsinteger or null
  • maxNightsinteger or null

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown