Lister les plans tarifaires d'un établissement

GET

/v1/rate-plans

curl --request GET \
  --url 'https://example.com/v1/rate-plans?pageSize=20&page=1&status=active&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

20

page

integer

>= 1

Example

1

status

string

Allowed values: active inactive

establishmentId

required

string format: uuid

Responses

200

Page de plans tarifaires

Media type application/json

object

data

required

Array<object>

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

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "status": "active",
      "pricingUnit": "per_room",
      "currency": "EUR",
      "cancellationPolicyKind": "non_refundable"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

400

Paramètres invalides

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
}

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
}