> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/site/api-site-coupon.md).

# /api/site/coupon

## GET /api/site/coupon

> Get a site coupon

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/coupon"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_site_coupon":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["couponid"]}}},"paths":{"/api/site/coupon":{"get":{"description":"Get a site coupon","tags":["/api/site/coupon"],"parameters":[{"name":"couponid","in":"query","schema":{"type":"integer"},"required":true},{"name":"redemption_counts","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_site_coupon"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_site_coupon"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_site_coupon"}}}}}}}}}
```

## POST /api/site/coupon

> Add new site coupon

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/coupon"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_site_coupon":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["siteid","code","start","optionids"]}}},"paths":{"/api/site/coupon":{"post":{"description":"Add new site coupon","tags":["/api/site/coupon"],"parameters":[{"name":"siteid","in":"query","schema":{"type":"integer"},"required":true},{"name":"programid","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"code","in":"query","schema":{"type":"string"},"required":true},{"name":"start","in":"query","schema":{"type":"string"},"required":true},{"name":"end","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"optionids","in":"query","schema":{"type":"string"},"required":true},{"name":"max_redemptions","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"unique_to_member","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_site_coupon"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_site_coupon"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_site_coupon"}}}}}}}}}
```

## PATCH /api/site/coupon

> Edit site coupon

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/coupon"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_site_coupon":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["couponid"]}}},"paths":{"/api/site/coupon":{"patch":{"description":"Edit site coupon","tags":["/api/site/coupon"],"parameters":[{"name":"couponid","in":"query","schema":{"type":"integer"},"required":true},{"name":"programid","in":"query","schema":{"type":"integer"},"required":false},{"name":"start","in":"query","schema":{"default":"--notset--","type":"string"},"required":false},{"name":"end","in":"query","schema":{"type":"string"},"required":false},{"name":"optionids","in":"query","schema":{"type":"string"},"required":false},{"name":"max_redemptions","in":"query","schema":{"type":"integer"},"required":false},{"name":"unique_to_member","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_site_coupon"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_site_coupon"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_site_coupon"}}}}}}}}}
```