---
title: "Inactives the given coupon on the bonifiq system."
method: POST
path: "/v1/pvt/Coupons/{code}/inactive"
tags: ["Coupons"]
---

# Inactives the given coupon on the bonifiq system.

`POST /v1/pvt/Coupons/{code}/inactive`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Coupons/{code}/inactive`
- Auth: HTTP basic

## Path parameters

- `code` string, required

## Response `200`

- BaseExternalApiListResponseOfCreateCouponResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `CouponCode` string: Coupon Code
    - `CreatedDate` string, date-time: Create Date
    - `IsUsed` boolean, nullable: if true the coupon was already bein use or inactivated.
    - `CouponValue` number: Discount value for the coupon
    - `CustomerId` integer: the customer that the coupon is being given.
    - `ValidDateStart` string, date-time, nullable: Date the coupon is start to being enable for rewards
    - `ValidDateEnd` string, date-time, nullable: Date the coupon will not be able for rewards anymore.
    - `CouponType` 0 | 1 | 2 | 3 | 4: 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
  - `TotalItemCount` integer: Total of rewards Configurations founds.
  - `PageSize` integer: Pagination size
  - `PageNumber` integer: Actual Page Number
  - `HasNextPage` boolean: true if there is another page to be load.
  - `HasError` boolean: If true the request had an error.
  - `ErrorMessages` string[]: List with the error messages

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)