---
title: "getRemainingOf"
method: GET
path: "/api/user/coupons/remaining-of/{couponPlanId}"
tags: ["user-coupon-resource"]
---

# getRemainingOf

`GET /api/user/coupons/remaining-of/{couponPlanId}`

## Request

- Base URL: `https://api.ayriaclub.ir`
- URL: `https://api.ayriaclub.ir/api/user/coupons/remaining-of/{couponPlanId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ayriaclub/apis/ayria-api/docs/api/user/coupons/remaining-of/:couponPlanId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `couponPlanId` integer, required

## Response `200`

OK

- UserCouponRemainingDto
  - `amount` number

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/ayriaclub/apis/ayria-api.md) - [All operations](https://skmtc.dev/ayriaclub/apis/ayria-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ayriaclub/apis/ayria-api/revisions/422df181c1dd?raw)