Aller au contenu

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>'
id
required
string format: uuid

Détail du plan tarifaire

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
Example
{
"data": {
"status": "active",
"pricingUnit": "per_room",
"currency": "EUR",
"cancellationPolicyKind": "non_refundable"
}
}

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
}

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
}

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
}