# Set the default payment term

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/setting/payment_term/{id}/default
```

- API version: v1
- Operation ID: `v1_public_payment_term_default`
- Section: Team settings › [Payment terms](https://developer.yoprint.com/reference/payment-terms.md)
- Web page: https://developer.yoprint.com/reference/payment-terms/v1-payment-term-default/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Makes this payment term the team default and returns it. The previous default stops being the default. New sales orders and quotes for customers without their own payment term use it.

## Permission

Needs the Manage Settings permission.

## Business rules

- YoPrint doesn't check whether the term is deleted. Restore a deleted term before you make it the default.

## Side effects

- Tells the team's open web app sessions that the default changed.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `id` (string, required): The payment term's `id`: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 `page_not_found`. Example `H3J5exdciYshbk`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_term/H3J5exdciYshbk/default' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `default` (boolean, required): Whether it is the team's default payment term.
  - `deposit_due` (integer, required): Days until the deposit is due. 0 when never set.
  - `deposit_due_from` (string | null, required): One of: `"issue_date"`.
  - `deposit_percent` (integer | null, required): The deposit percentage. A percentage ×1000: `8250` is 8.25% (`20000` is 20%). With `X-Yoprint-Decimal-Format: exact-v1`, a value that isn't a whole number comes back as a string.
  - `enable_deposit` (boolean, required): Whether a deposit is required before production.
  - `full_amount_due` (integer, required): Days until full payment is due.
  - `full_amount_due_from` (string, required): What the days count from: the issue date, or the customer due date. One of: `"issue_date"`, `"customer_due_date"`.
  - `id` (string, required)
  - `name` (string, required)
  - `trashed` (boolean, required): True for a deleted payment term.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "default": true,
    "deposit_due": 30,
    "deposit_due_from": "issue_date",
    "deposit_percent": 20000,
    "enable_deposit": true,
    "full_amount_due": 30,
    "full_amount_due_from": "issue_date",
    "id": "H3J5exdciYshbk",
    "name": "20/80 (20% deposit/upfront)",
    "trashed": false
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
  - When: The API key is missing or wrong. Fix: Send your personal API key as `Authorization: Bearer YOUR_API_KEY`.
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your permission group lacks Manage Settings. This 403 has a short body, `{"message": "Insufficient Permission"}`, without `success` or `error`. Fix: Ask the team owner to give your permission group Manage Settings.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No payment term with that id on this team (`error.code` is null and `error.message` starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both `page_not_found`). Fix: Use an `id` from the list operation and check the team slug.

## Related

- [List payment terms](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-index.md): `GET /v1/api/store/{team_slug}/setting/payment_term`
