Update Order

Update a specific order in the current workspace. External orders have different updateable fields than orders that have a regular payment processor like Payments AI or Stripe.

Use trial_end_at or renewal_at to adjust a processor-managed subscription's dates. Both
take absolute RFC 3339 timestamps. A change whose exact requested value the processor confirmed
returns 200; an accepted change whose exact requested value ClickFunnels could not confirm
returns 202; a rejected or unapplied change returns 422. Updates without schedule fields
return 200.

For an actual schedule change, on 200 as well as 202 the order in the response will carry
the pre-change trial_end_at / renewal_at: the dates are applied at the payment processor
rather than stored, and the local columns settle when its sync lands. Keep the pre-request value
and poll GET /orders/{id} with backoff. After 200, wait for the timestamp you sent, comparing
parsed instants at whole-second precision rather than timestamp strings. After 202, wait for
the field to differ from its pre-request value, then use the returned value as the effective
schedule. Choose your own timeout because there is no fixed settlement deadline. If it expires,
the outcome is unknown, not failed; do not retry the PATCH blindly. A schedule change never
re-dates an invoice that has already been issued, so confirm it on the order's dates rather than
on an invoice period.

To stop a subscription from renewing, use POST /orders/{id}/cancel (see Cancel a subscription in the Orders Skill).

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

Information about updated fields in Order

order
object

Update parameters for orders. All fields are optional.
Most fields are only applicable to external orders (orders with payment_processor: external).

trial_end_at and renewal_at adjust processor-managed subscription dates. They require the
same permission as the corresponding ClickFunnels screens; unauthorized changes return 404.
A null or unchanged value does not request a schedule change.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json