v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

Invoices

Generate advance terms

post/sellers/{seller_id}/invoices/{id}/terms/generate

Path parameters

seller_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Response

Successful operation

idstring required

id of object (seller, invoice) associated with this payout

receivableinteger required

amount of receivable

currencystring required

currency of receivable. all amounts are in this currency.

endstring date

date on which receivable is due

advanceinteger required

amount to be advanced

daily_feeinteger required

daily fee applied

daysinteger required

expected number of days

feeinteger

minimum fee applied upfront for this advance, calculated as days * daily fee

reserveinteger

reserve amount to cover late payments, refunded when payment is received

transferinteger required

amount to be transferred upon acceptance, calculated as advance - minimum_fee - reserve

expires_atstring date-time

terms need to be accepted before expiration, if terms have expired they can be regenerated

Example response

{
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "receivable": 10000,
  "currency": "USD",
  "end": "2024-01-15",
  "advance": 10000,
  "daily_fee": 10000,
  "days": 42,
  "fee": 10000,
  "reserve": 10000,
  "transfer": 10000,
  "expires_at": "2024-01-15T10:30:00Z"
}