Coupons

Get a coupon

Changed on Oct 31, 2026

Retrieve a coupon. Requires the coupons:read scope. A deleted coupon, or one from the other environment, returns 404.

get/v1/coupons/{couponId}

Request

Base URL
https://api.yuvexpay.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/yuvexpay/apis/yuvexpay-api/docs/v1/coupons/:couponId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

couponIdstring uuid required

The coupon ID.

Response

Coupon found.

Example response

{
  "coupon": {
    "code": "BLACK10"
  }
}

Changes

Oct 31, 20265236ef291a8e Revision changes
- info
  endpoint added

Operation history