> 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/payment/api-payment-payout-period.md).

# /api/payment/payout‑period

## GET /api/payment/payout-period

> Get payout period details

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payout-period"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_payment_payout-period":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payout_period_id"]}}},"paths":{"/api/payment/payout-period":{"get":{"description":"Get payout period details","tags":["/api/payment/payout-period"],"parameters":[{"name":"payout_period_id","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_payment_payout-period"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_payment_payout-period"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_payment_payout-period"}}}}}}}}}
```

## POST /api/payment/payout-period

> Add new payout period

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payout-period"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_payment_payout-period":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["description","configuration_type","configuration_days","projection_type"]}}},"paths":{"/api/payment/payout-period":{"post":{"description":"Add new payout period","tags":["/api/payment/payout-period"],"parameters":[{"name":"description","in":"query","schema":{"type":"string"},"required":true},{"name":"configuration_type","in":"query","schema":{"type":"string"},"required":true},{"name":"configuration_days","in":"query","schema":{"type":"string"},"required":true},{"name":"projection_type","in":"query","schema":{"type":"string"},"required":true},{"name":"projection_days","in":"query","schema":{"type":"string"},"required":false},{"name":"projection_padding","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"delay","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"positive_pay_delay","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"negative_pay_delay","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"enabled","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_payment_payout-period"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_payment_payout-period"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_payment_payout-period"}}}}}}}}}
```

## DELETE /api/payment/payout-period

> delete payout period

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payout-period"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_payment_payout-period":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payout_period_id"]}}},"paths":{"/api/payment/payout-period":{"delete":{"description":"delete payout period","tags":["/api/payment/payout-period"],"parameters":[{"name":"payout_period_id","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_payment_payout-period"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_payment_payout-period"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_payment_payout-period"}}}}}}}}}
```

## PATCH /api/payment/payout-period

> Edit payout period

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payout-period"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_payment_payout-period":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payout_period_id"]}}},"paths":{"/api/payment/payout-period":{"patch":{"description":"Edit payout period","tags":["/api/payment/payout-period"],"parameters":[{"name":"payout_period_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"description","in":"query","schema":{"type":"string"},"required":false},{"name":"configuration_type","in":"query","schema":{"default":"--broken--","type":"string"},"required":false},{"name":"configuration_days","in":"query","schema":{"type":"string"},"required":false},{"name":"projection_type","in":"query","schema":{"default":"--broken--","type":"string"},"required":false},{"name":"projection_days","in":"query","schema":{"type":"string"},"required":false},{"name":"projection_padding","in":"query","schema":{"type":"integer"},"required":false},{"name":"delay","in":"query","schema":{"type":"integer"},"required":false},{"name":"positive_pay_delay","in":"query","schema":{"type":"integer"},"required":false},{"name":"negative_pay_delay","in":"query","schema":{"type":"integer"},"required":false},{"name":"enabled","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_payment_payout-period"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_payment_payout-period"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_payment_payout-period"}}}}}}}}}
```