List Adjustment Types
Beta/v1/finance/adjustment-typesThis endpoint is idempotent. Learn more
Returns a paginated list of adjustment types.
cursoroptional stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
include[]optional arrayenumValues:ownerSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of adjustment_typeResources in this page.
idstringAdjustment type ID.
objectstringenumValues:adjustment_typeResource type identifier.
namestringHuman-readable name of the adjustment type (e.g. "Discount").
codestringenumValues:discountshipping_discrepancyshort_paymentMachine-readable code identifying what kind of adjustment this is.
discount: a price reduction.shipping_discrepancy: corrects a difference between quoted and actual freight.short_payment: reconciles an invoice paid for less than the amount due.write_off: cancels an uncollectible balance.fee: an additional charge.refund: returns money to the customer.
ownerownerExpandablenullableProvenance of this adjustment type.
System-owned types are platform-provided defaults shared across all accounts; account-owned types are custom to one account.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountWhere this resource came from.
system: a platform-provided default shared across all accounts; not editable.account: created and owned by a specific account; theaccountfield identifies which.
accountaccountnullableThe account that owns this resource.
Present only when type is account; system-owned resources have no owning account.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for List Adjustment Types