Create Payment Term

Beta
POST/v1/finance/payment-terms

Idempotent with Idempotency-Key header. Learn more

Creates a payment term.

The new term is owned by your account and starts with status active.

Permissions requiredValues:payment_terms:create
The role behind your API key or agent must grant every one of these permissions.
include[]optional arrayenumValues:ownerowner.account

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

namestring

Display name (e.g. Net 30).

Must be unique among the payment terms visible to your account, including system defaults.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30).

statusstringenumValues:activeinactive

Lifecycle status of the payment term.

ownerownerExpandablenullable

Owner of this resource, indicating whether it is an Augno-provided system default or was created by your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.
portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

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

201

Successful response for Create Payment Term