---
title: "POST /v1/rewards.list"
method: POST
path: "/v1/rewards.list"
tags: ["rewards"]
---

# POST /v1/rewards.list

`POST /v1/rewards.list`

List the coupons and feature grants configured for the org.

## Headers

- `x-api-version` string, required

## Request body

- object

## Response `200`

OK

- object
  - `coupons` object[], required — The list of coupons configured for the organization.
    - `id` string, required — The unique identifier for the coupon.
    - `name` string, nullable — A human-readable name for the coupon.
    - `type` 'percentage_discount' | 'fixed_discount' | 'invoice_credits', required — The type of discount: percentage_discount, fixed_discount, or invoice_credits.
    - `value` number, required — The discount value. A percentage for percentage_discount, or an amount for fixed_discount / invoice_credits.
    - `duration` object, required — How long the coupon applies once redeemed.
      - `type` 'one_off' | 'months' | 'forever', required — The unit of time the duration is measured in.
      - `length` number, nullable, required — The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
    - `plan_ids` string[], nullable, required — The plan IDs the coupon applies to, or null when it applies to all plans.
    - `promo_codes` object[], required — The promo codes customers can use to redeem the coupon.
      - `code` string, required — The promo code customers enter to redeem the coupon.
      - `global_max_redemption` number, nullable — Maximum number of times this promo code can be redeemed across all customers, or null for unlimited.
      - `first_time_transaction` boolean, nullable — Whether this promo code can only be applied to a customer's first transaction.
    - `created_at` number, required — The Unix timestamp (in milliseconds) when the coupon was created.
  - `feature_grants` object[], required — The list of feature grants configured for the organization.
    - `id` string, required — The unique identifier for the feature grant.
    - `name` string, nullable — A human-readable name for the feature grant.
    - `grants` object[], required — The feature grants awarded when the grant is redeemed.
      - `feature_id` string, required — The feature ID this grant applies to.
      - `included` number, nullable, required — The amount of the feature granted, or null for boolean features.
      - `expiry` object, nullable, required — How long the granted amount lasts before expiring, or null for a permanent grant.
        - `type` 'day' | 'week' | 'month' | 'year', required — The unit of time the duration is measured in.
        - `length` number, nullable, required — The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
    - `promo_codes` object[], required — The promo codes customers can use to redeem the feature grant.
      - `code` string, required — The promo code customers enter to redeem the feature grant.
      - `max_uses` number, nullable, required — Maximum number of times this promo code can be redeemed, or null for unlimited.
    - `created_at` number, required — The Unix timestamp (in milliseconds) when the feature grant was created.

---

[API](https://skmtc.net/useautumn/apis/autumn-api.md) · [All operations](https://skmtc.net/useautumn/apis/autumn-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/useautumn/autumn-api/revisions/29536933c0dc/schema)