Update a payment term

PUT/v1/api/store/{team_slug}/setting/payment_term/{hash_id}

v1Operation ID v1_public_payment_term_update_put

Changes a payment term and returns it. Send only the fields to change. default: true makes it the team default.

Orders that already use the term keep the values they copied.

Permission

Needs the Manage Settings permission.

Business rules

• 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.

Side effects

• With default: true, it becomes the default for new orders of customers without their own payment term.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  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

application/json, required.

• defaultboolean

  true makes it the team's default payment term.

• deposit_dueinteger

  Days until the deposit is due.

• deposit_due_fromstring

  Always issue_date.

  • One of: "issue_date"
• deposit_percentinteger

  Send a whole number as a percentage ×1000: 8250 is 8.25% (20000 is 20%, 33333 is 33.333%).

  • Minimum 0
• enable_depositboolean

  Require a deposit before production. When true, deposit_percent, deposit_due and deposit_due_from are required.

• full_amount_dueinteger

  Days until full payment is due.

• full_amount_due_fromstring

  What the days count from.

  • One of: "issue_date", "customer_due_date"
• namestring

Response

200Successful response.

• dataobjectrequired
  Child fields (10)

  • defaultbooleanrequired

    Whether it is the team's default payment term.

  • deposit_dueintegerrequired

    Days until the deposit is due. 0 when never set.

  • deposit_due_fromstring | nullrequired
    • One of: "issue_date"
  • deposit_percentinteger | nullrequired

    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_depositbooleanrequired

    Whether a deposit is required before production.

  • full_amount_dueintegerrequired

    Days until full payment is due.

  • full_amount_due_fromstringrequired

    What the days count from: the issue date, or the customer due date.

    • One of: "issue_date", "customer_due_date"
  • idstringrequired
  • namestringrequired
  • trashedbooleanrequired

    True for a deleted payment term.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The 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.

• 403You 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.

• 404Not 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.

• 422The 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 value has the wrong type, 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%.

Related

• GETShow a payment term/v1/api/store/{team_slug}/setting/payment_term/{hash_id}

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_term/H3J5exdciYshbk' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "full_amount_due": 45  }'

Example response 200

Response

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