> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# CheckoutCoupon

GraphQL object

The checkout coupon.

Reference: https://docs.bigcommerce.com/developer/api-reference/graphql/storefront/types/objects/checkout-coupon

## Fields

- `entityId` — The coupon ID.
- `promotionEntityId` — The ID of the promotion that generated this coupon.
- `code` — The coupon code.
- `couponType` — The coupon type.
- `discountedAmount` — The discounted amount applied within a given context.
- `discountedAmountInDisplayCurrency` — Discounted amount in display currency.
- `displayName` — The display name of the coupon.
- `status` — The status of the coupon.
- `hasMaxLimitReached` — Indicates whether the coupon has reached its maximum limit.

## Definition

```graphql
type CheckoutCoupon {
  entityId: Int!
  promotionEntityId: Int!
  code: String!
  couponType: CouponType
  discountedAmount: Money!
  discountedAmountInDisplayCurrency: Money!
  displayName: String
  status: CouponStatus
  hasMaxLimitReached: Boolean!
}
```