List Payment Terms
Beta/v1/finance/payment-termsThis endpoint is idempotent. Learn more
Returns a paginated list of payment terms. Includes both account-specific and system default payment terms.
cursoroptional stringQuery parameter: cursor for List Payment Terms
limitoptional integerQuery parameter: limit for List Payment Terms
qoptional stringQuery parameter: q for List Payment Terms
include[]optional arrayenumValues:ownerowner.accountSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listObject type for PaymentTerm list
page_infoobjectPagination metadata for PaymentTerm list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of PaymentTerm resources in this page
idstringPayment term ID.
objectstringenumValues:payment_termResource type identifier.
namestringDisplay name.
statusstringenumValues:active|inactivePayment term status.
ownerobjectExpandablenullableOwner of this resource.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountThe owner type: "system" for platform defaults, "account" for account-owned resources.
accountobjectExpandablenullableThe account that owns this resource. null if the object is system-owned.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringDisplay name.
default_billing_addressobjectnullableDefault billing address.
null in this endpoint.default_shipping_addressobjectnullableDefault shipping address.
null in this endpoint.brandingobjectnullableBranding configuration.
null in this endpoint.portalobjectnullablePortal configuration.
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
Successful response for List Payment Terms