integrations

Check a coupon code (internal) Deprecated

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
POST /payments/check-coupon
Access token

Looks up a Stripe promotion code and returns whether it can still be redeemed, its id and its discount as a percentage or a flat amount in cents. An unknown code returns isValid: false with the other fields null.

application/json

Body Required

  • code string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • isValid boolean Required
      • id string Required
      • type string Required

        Values are percentage or flat.

      • value number Required
    • statusCode number Required
    • timestamp string(date-time) Required
POST /payments/check-coupon 
curl \
 --request POST 'http://api.example.com/payments/check-coupon' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "code": "string"
}'
Request examples 
{
  "code": "string"
}
Response examples (200) 
{
  "data": {
    "isValid": true,
    "id": "promo_1PExample",
    "type": "percentage",
    "value": 20
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}