---
title: "Get trash settings"
method: GET
path: "/documents/trash-settings"
tags: ["Document AI — DMS"]
---

# Get trash settings

`GET /documents/trash-settings`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/trash-settings`
- Auth: HTTP bearer

Update or read the account-wide trash retention setting.

## Query parameters

- `retention_days` integer

## Response `200`

Success

- object
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `_capabilities` object
    - `workspace_tier` string
    - `trash_enabled` boolean
    - `soft_delete_supported` boolean
    - `delete_mode_effective_default` string
    - `retention_at_document_type` boolean
    - `worm_at_document_level` boolean
    - `compliance_pdf_watermark` boolean
    - `audit_trail_readable` boolean
    - `audit_trail_source` string
    - `audit_trail_scope` string
    - `revision_trail_requires_document_worm` boolean
    - `headless_gobd_recommended_tier` string
  - `_tier_summary` string
  - `delete_mode_effective_default` string
  - `processing_time` string
  - `status` string
  - `trash_enabled` boolean
  - `trash_retention_days` integer
  - `workspace_tier_effective` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)