Retrieve a customer's eligible promotions

  • Customers
  • Payment
  • 1 route
How do I retrieve a client's list of offers?

This route retrieves all the promotions a client is eligible for.

It only requires a client's ID and returns all available promotions for that client in response.

Promotions can belong to different categories, including:

  • Credit notes (CREDIT_NOTE)
  • Sponsorship (SPONSORSHIP)
  • Targeted offers (TARGETED_OFFER)
  • Refunds (REFUND)

Overview

Use this scenario to retrieve the promotions or commercial benefits available for a given customer account. The response can feed a customer area, a seller cockpit, or a quotation flow that needs eligible offers before pricing.

Prerequisites

  • Have a valid customer_id.
  • Send authorization, x-api-key, and accept-language when your integration context requires them.
1

Retrieve a customer's commercial offers

Mandatory

This route returns the commercial offers available for a given customer.

Prerequisites

Use customer_id with a valid authorization token. Add date_format if you need a specific date format in the response.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "accept-language: en-US" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.clubmed.com/v2/customers/{customer_id}/commercial_offers?date_format=Y-m-d"

Example answer

[
  {
    "id": "offer-1",
    "type": "PROMOTION",
    "offer_id": "PROMO2026",
    "label": "Summer Promo",
    "code": "SUMMER",
    "value": 10,
    "unit": "PERCENT",
    "currency": "EUR",
    "status": "ACTIVE"
  }
]

info: The response can be used to display eligible promotions or prepare a personalized proposal.

Response codes

  • 200 OK: the commercial offers are returned.
  • 400 Bad Request: invalid parameters.
  • 401 Unauthorized: missing or invalid token.
  • 403 Forbidden: the customer is not accessible in this context.
GET/v2/customers/{customer_id}/commercial_offers
See more