Coupons

Redeem a coupon

Redeems a free_signature coupon, converting the granted signatures into credits added to the tenant's balance.

Important

  • Only free_signature coupons can be redeemed here. discount coupons must be applied directly at signature checkout and are rejected with 400.
  • Redemption is idempotent: a tenant can redeem a given coupon only once (unique constraint on coupon + tenant). A repeat attempt returns 409.

Usage Example

curl -X POST https://api.faireplace.com/api/coupons/redeem \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "code": "PROMO2024" }'

Response:

{
  "code": "PROMO2024",
  "kind": "free_signature",
  "signatures_count": 2,
  "new_balance_cents": 150000,
  "message": "2 signature(s) offerte(s) ajoutée(s) à votre solde"
}
post/coupons/redeem

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/coupons/redeem
  • Auth: HTTP bearer

Request body

codestring required

Coupon code to redeem.

Example request

{
  "code": "PROMO2024"
}

Response

Coupon redeemed; credits added to the balance.

codestring required

Coupon code.

kind'free_signature' required

Always free_signature for a redeemable coupon.

signatures_countinteger required

Number of free signatures granted by this redemption.

new_balance_centsinteger required

New credit balance in euro cents after the redemption.

messagestring required

User-friendly confirmation message.

Example response

{
  "code": "PROMO2024",
  "kind": "free_signature",
  "signatures_count": 2,
  "new_balance_cents": 150000,
  "message": "2 signature(s) offerte(s) ajoutée(s) à votre solde"
}

Changes

No recorded changes to this operation across all 1 revision of this API.