# Retrieve coupon redemptions

Retrieves a list of coupon redemptions.

Endpoint: GET /coupons-redemptions
Version: latest
Security: SecretApiKey, JWT

## Security:

  - `SecretApiKey` (unknown)
    apiKey in header REB-APIKEY

  - `JWT` (unknown)
    http bearer JWT

## Query parameters:

  - `limit` (integer)
    Limit the number of collection items to be returned.
Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Criteria for filtering collection items.
This field requires a special format.
Use `,` to specify multiple allowed values.
Use `;` to specify multiple fields.

For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).

  - `q` (string)
    Use this field to perform a partial search of text fields.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.

## Response 200:

  - `200` (unknown)
    List of coupon redemptions retrieved.

## Response 200 fields (application/json):

  - `id` (string)
    Unique resource ID.
    Example: cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR

  - `couponId` (string)
    ID of the coupon.
    Example: cpn_0YVCNKF81GD778N4YNVGDJK558

  - `customerId` (string)
    ID of the customer resource.
    Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF

  - `additionalRestrictions` (array)
    Additional coupon redemption restrictions.

  - `additionalRestrictions.type` (string, required)
    Type of coupon restriction.
    Enum: "discounts-per-redemption"

  - `additionalRestrictions.quantity` (integer, required)
    Permitted number of discounts per redemption.

  - `additionalRestrictions.amount` (number, required)
    Maximum order amount that is allowed to apply the coupon.

  - `additionalRestrictions.currency` (string, required)
    Currency code in ISO 4217 format.
    Example: USD

  - `additionalRestrictions.amount` (number, required)
    Minimum order quantity that is required to apply the coupon.

  - `additionalRestrictions.time` (string, required)
    Date and time when a coupon redemption is no longer valid, and the coupon is removed from unpaid invoices if applied.
> **Note:** This date-time cannot be changed.

  - `additionalRestrictions.invoiceIds` (array, required)
    Invoice IDs on which a coupon can be applied.

  - `additionalRestrictions.planIds` (array, required)
    Plan IDs on which a coupon can be applied.

  - `additionalRestrictions.minimumQuantity` (integer)
    Minimum quantity that is required to apply the restriction and subsequent discount.

  - `additionalRestrictions.productIds` (array, required)
    Product IDs on which a coupon can be applied.

  - `additionalRestrictions.subscriptionIds` (array, required)
    Subscription IDs on which a coupon can be applied.

  - `createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `canceledTime` (string | null)
    Date and time when the coupon is canceled.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "customer", "coupon"

## Response 200 headers (application/json):

  - `Pagination-Total` (integer)
    Total number of items that match the request.
The value is independent of `limit`, including when `limit` is `0`.
    Example: 332

  - `Pagination-Limit` (integer)
    Maximum number of items per page.
    Example: 100

  - `Pagination-Offset` (integer)
    Specifies the starting point within the
collection of resource results. For example, a request with
`limit=20` retrieves and displays the first 20 results on a page. A
following request with `limit=20` and `offset=20`, retrieves the next
page of 20 results.
    Example: 2

## Response 401:

  - `401` (unknown)
    Unauthorized access.
Invalid credentials used.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403:

  - `403` (unknown)
    Access forbidden.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.