Détail d'un plan tarifaire

GET

/v1/rate-plans/{id}

curl --request GET \
  --url https://example.com/v1/rate-plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Détail du plan tarifaire, enrichi des conditions de vente (ADR-00D116 : sellPeriod, unitTypeIds, fences — additif)

Media type application/json

object

data

required

object

id

required

string format: uuid

establishmentId

string format: uuid

code

required

string

name

required

string

status

required

string

Allowed values: active inactive

pricingUnit

required

string

Allowed values: per_room per_person derived

baseRateCents

Tarif de base nuit en centimes (bigint string)

string

nullable

currency

required

string

Allowed values: EUR GBP

cancellationPolicyKind

string

nullable

Allowed values: non_refundable refundable

depositScheme

Barème d’acompte (ADR-00D114). null = pas de barème. TAUX + échéance, NI montant NI nature juridique.

object

basisPoints

required

Part du total séjour en basis points (3000 = 30 %).

integer

>= 1 <= 10000

dueDaysBeforeArrival

required

Jours avant l’arrivée où l’acompte est dû.

integer

captureOnNoShow

required

boolean

baseRateRule

required

Structure tarifaire complète (union discriminée sur pricingUnit). Champs présents selon le discriminant.

object

pricingUnit

required

string

Allowed values: per_room per_person derived

currency

required

string

Allowed values: EUR GBP

flatNightlyCents

(per_room) Tarif nuit forfaitaire en centimes (bigint string).

string

nullable

derivedFromRatePlanId

(derived) Plan source.

string format: uuid

nullable

derivedBasisPoints

(derived) Points de base (8000 = 80 %).

integer

nullable

occupancy

(per_person) Grille de tarification à l’occupant. Montants en centimes (bigint string).

object

baseUnitNightlyCents

required

string

adultNightlyCents

required

string

childTiers

required

Array<object>

object

ageFrom

required

integer

ageTo

required

integer

nightlyCents

required

string

infantFreeUpToAge

required

integer

petNightlyCents

required

string

extraVehicleNightlyCents

required

string

includedVehicles

required

integer

electricityMode

required

string

Allowed values: included metered flat_surcharge

electricityFlatNightlyCents

string

nullable

sellPeriod

required

Période de vente (ADR-00D116 A1) — fenêtre sur les dates d’ARRIVÉE, bornes incluses, chacune nullable (semi-ouverte). null = toujours vendable.

object

from

required

string format: date

nullable

to

required

string format: date

nullable

unitTypeIds

required

Allowlist de types d’unité (ADR-00D116 A4). Vide = tous les types.

Array<string>

fences

required

Fences d’éligibilité du plan (ADR-00D116 A5). Le type est la clé naturelle (upsert POST /:id/fences, DELETE /:id/fences/:type).

Array<object>

object

type

required

string

Allowed values: min_lead_time max_lead_time channel segment corporate_code

thresholdDays

required

Achat anticipé en jours (min/max_lead_time).

integer

nullable

allowedValues

required

Valeurs autorisées (channel : desk|booking_engine|ota ; segment : libre).

Array<string>

requiredCode

required

Code société exigé (corporate_code) — surface de CONFIG, jamais dans les devis.

string

nullable

Example

{
  "data": {
    "status": "active",
    "pricingUnit": "per_room",
    "currency": "EUR",
    "cancellationPolicyKind": "non_refundable",
    "baseRateRule": {
      "pricingUnit": "per_room",
      "currency": "EUR",
      "occupancy": {
        "electricityMode": "included"
      }
    },
    "fences": [
      {
        "type": "min_lead_time"
      }
    ]
  }
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée ou scope IDOR

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

404

Plan introuvable

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}