Update Payment Term

Beta

PATCH/v1/finance/payment-terms/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a payment term. Default payment terms cannot be updated.

idstring

Payment term ID.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Display name.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name.

statusstringenumValues:active|inactive

Payment term status.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Update Payment Term

Update Payment Term

curl API_HOST/v1/finance/payment-terms/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Net 60"
}'

curl API_HOST/v1/finance/payment-terms/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Net 60"
}'

200 example

{
  "id": "pytm_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "payment_term",
  "name": "Net 30",
  "status": "active",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pytm_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "payment_term",
  "name": "Net 30",
  "status": "active",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Payment Term

Path Parameters

Query Parameters

Request Body

Returns

Responses