orders

Update order

Update an order by ID

put/orders/{id}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/orders/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
startDatestring date-time
endDatestring date-time
subscriptionTermsinteger
creationState'draft' | 'active'
billingAnchorinteger

Day of month for billing anchor (1-31). Defaults to start date day if not provided.

paymentTermsstring
externalIdstring
metadataobject
billingCustomerIdstring
billingContactIdsstring[]
autoPostInvoicesboolean
autoSendBillingEmailsboolean
autoSendPaymentEmailsboolean
purchaseOrderReferencestring nullable

Purchase order number printed on invoices generated from this order.

Response

200

idstring required
customerIdstring required
billingCustomerIdstring nullable required
billingContactIdsstring[] required
createdAtstring date-time required
updatedAtstring date-time required
endDatestring date-time nullable required
namestring required
startDatestring date-time required
subscriptionTermsinteger nullable required
billedAmountNoTaxnumber double required
billedTaxnumber double required
estimatedTaxnumber double required
orderAmountnumber double required
pendingBillingAmountnumber double required
totalAmountnumber double required
totalBilledAmountnumber double required
creationState'draft' | 'active' required
paymentTermsstring nullable required
numbernumber double required
metadataobject nullable required
showPaymentLinkboolean nullable required
showBankDetailsboolean nullable required
autoPostInvoicesboolean nullable required
autoSendBillingEmailsboolean nullable required
autoSendPaymentEmailsboolean nullable required
versioninteger required
billingFrequencyOverriddenboolean required
purchaseOrderReferencestring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.