PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

Update an order

patch
https://orders-api.paymongo.com/v1/orders/

Updates an order's items, tips, custom fees, customer, or metadata. On a group order every update requires a participant_id belonging to a group that has not expired; version drives optimistic locking.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Order ID

Body Params

Order fields to update

custom_fees
array of objects

CustomFees replaces the order's whole fee list when present ([] clears it); omitted leaves it unchanged.

custom_fees
customer
object
items
array of objects
items
metadata
object

Metadata replaces the order's whole metadata object when present ({} clears it); omitted leaves it unchanged. A flat string map: up to 50 keys, key names 1 to 40 characters, values up to 500 characters.

string

Group orders: participant_id identifies the editor; version is the
client-known order version for optimistic locking. livemode is derived
from the auth header, not the body.

tips
object
integer
Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?