> For the complete documentation index, see [llms.txt](https://vauchar.gitbook.io/vauchar/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vauchar.gitbook.io/vauchar/api-references/coupons/models.md).

# Models

## The Coupon object

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"components":{"schemas":{"Coupon":{"type":"object","properties":{"href":{"type":"string","description":"The direct URL to this specific coupon resource."},"type":{"type":"string","description":"The type of the object, in this case, \"coupon\"."},"id":{"type":"string","description":"The unique identifier for the coupon."},"coupon_code":{"type":"string","description":"The code that customers use to redeem the coupon."},"created":{"type":"integer","format":"int64","description":"The timestamp when the coupon was created (Unix timestamp)."},"start_time":{"type":"integer","format":"int64","description":"The timestamp when the coupon becomes valid (Unix timestamp)."},"expiry_time":{"type":"integer","format":"int64","description":"The timestamp when the coupon expires (Unix timestamp). A value of 0 means it never expires."},"allowed_users":{"type":"integer","description":"The number of specific users allowed to use this coupon. 0 means unlimited."},"redemptions_limit_total":{"type":"integer","description":"The total number of times this coupon can be redeemed across all users. 0 means unlimited."},"redemptions_limit_per_user":{"type":"integer","description":"The number of times a single user can redeem this coupon. 0 means unlimited."},"value":{"type":"string","description":"The discount value of the coupon."},"value_unit":{"type":"string","description":"The unit of the discount value (e.g., 'value' for fixed amount, 'percent')."},"currency":{"type":"string","description":"The currency of the coupon's value (e.g., 'USD')."},"active_status":{"type":"integer","description":"The status of the coupon. 1 for active, 0 for inactive."}}}}}}
```

## The ValidationStatus object

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"components":{"schemas":{"ValidationStatus":{"type":"object","properties":{"status":{"type":"integer","description":"A status code indicating the result of the validation."},"message":{"type":"string","description":"A human-readable message describing the validation status."}}}}}}
```

## The Redemption object

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"components":{"schemas":{"Redemption":{"type":"object","properties":{"href":{"type":"string","description":"The direct URL to this specific redemption resource."},"type":{"type":"string","description":"The type of the object, in this case, \"redemption\"."},"id":{"type":"string","description":"The unique identifier for the redemption."},"coupon_id":{"type":"string","description":"The ID of the coupon that was redeemed."},"user_id":{"type":"string","description":"The ID of the user who redeemed the coupon."},"customer_id":{"type":"string","description":"The ID of the customer associated with the redemption."},"user_email":{"type":"string","description":"The email of the user who redeemed the coupon."},"user_phone":{"type":"string","description":"The phone number of the user who redeemed the coupon."},"transaction_id":{"type":"string","description":"The ID of the transaction associated with this redemption."},"value_used":{"type":"string","description":"The value of the discount applied in this redemption."},"team_id":{"type":"string","description":"The ID of the team associated with this redemption, if any."},"created":{"type":"integer","format":"int64","description":"The timestamp when the redemption occurred (Unix timestamp)."}}}}}}
```

## The RedemptionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"components":{"schemas":{"RedemptionRequest":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The unique identifier for the user redeeming the coupon."},"user_email":{"type":"string","description":"The email address of the user."},"user_phone":{"type":"string","description":"The phone number of the user."},"transaction_id":{"type":"string","description":"The identifier for the transaction this redemption is part of."},"value_used":{"type":"number","description":"The value used in this specific transaction."}}}}}}
```