# Create a payment term

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

- API version: v1
- Operation ID: `v1_public_payment_term_store`
- 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-store/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Creates a payment term and returns it.

A payment term says whether an order needs a deposit, how big, and when the deposit and full payment are due. A new sales order or quote takes the customer's default payment term, or else the team's default. YoPrint copies the term onto the order: the deposit requirement and percentage, a full payment due date `full_amount_due` days after the order is created and, when a deposit is required, a deposit due date `deposit_due` days after it. Changing or deleting a term later doesn't change existing orders.

The first payment term of a team becomes its default. `default: true` doesn't switch the default when the team already has one; call Set the default payment term after creating it.

## Permission

Needs the Manage Settings permission.

## Business rules

- `name`, `full_amount_due` and `full_amount_due_from` are required.
- With `enable_deposit: true`, `deposit_percent`, `deposit_due` and `deposit_due_from` are required.
- `deposit_percent` is a whole number of 0 or more (a percentage ×1000: `8250` is 8.25%). YoPrint doesn't cap it at 100%.
- `deposit_due_from` is `issue_date`; `full_amount_due_from` is `issue_date` or `customer_due_date`.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `full_amount_due` (integer, required): Days until full payment is due.
- `full_amount_due_from` (string, required): What the days count from. One of: `"issue_date"`, `"customer_due_date"`.
- `name` (string, required)
- `default` (boolean, optional): `true` makes it the default only when the team has no default yet. To switch the default, call Set the default payment term.
- `deposit_due` (integer, optional): Days until the deposit is due.
- `deposit_due_from` (string, optional): Always `issue_date`. One of: `"issue_date"`.
- `deposit_percent` (integer, optional): Send a whole number as a percentage ×1000: `8250` is 8.25% (`20000` is 20%, `33333` is 33.333%). Minimum 0.
- `enable_deposit` (boolean, optional): Require a deposit before production. When true, `deposit_percent`, `deposit_due` and `deposit_due_from` are required.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_term' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "deposit_due": 0,
    "deposit_due_from": "issue_date",
    "deposit_percent": 50000,
    "enable_deposit": true,
    "full_amount_due": 30,
    "full_amount_due_from": "issue_date",
    "name": "50/50"
  }'
```

Another example: Net 30, no deposit:

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_term' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "enable_deposit": false,
    "full_amount_due": 30,
    "full_amount_due_from": "issue_date",
    "name": "Net 30"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required): The new payment term, as built from your request: `enable_deposit`, `deposit_percent`, `deposit_due` and `deposit_due_from` are null when you left them out (YoPrint stores `false`, null, `0` and null). Read it back with Show a payment term for the stored values.
  - `default` (boolean, required): Whether it is the team's default payment term.
  - `deposit_due` (integer | null, 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 | null, 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": false,
    "deposit_due": 0,
    "deposit_due_from": "issue_date",
    "deposit_percent": 50000,
    "enable_deposit": true,
    "full_amount_due": 30,
    "full_amount_due_from": "issue_date",
    "id": "H3J5exdciYshbk",
    "name": "50/50",
    "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.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A required field is missing, a day count is not a number, a `*_from` value is not allowed, or `deposit_percent` is negative. `error.code` is `validation_failed`, and `error.fields` names each field with its messages. Fix: Fix the fields listed in `error.fields` and send the request again.
  - When: `deposit_percent` is not a whole number, or is too large (`error.code` `amount_out_of_range`). Fix: Send the percentage ×1000 as a whole number: `8250` is 8.25%, `33333` is 33.333%.

## Notes

- The answer echoes what you sent. Fields you left out are null in it, even though YoPrint stores defaults for them; send every field, or read the term back.

## Related

- [Set the default payment term](https://developer.yoprint.com/reference/payment-terms/v1-payment-term-default.md): `PATCH /v1/api/store/{team_slug}/setting/payment_term/{id}/default`