Skip to navigation

Update Processor Route

View as Markdown

Update a processor route.

Can update name, description, and/or the ordered list of processors.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

route_idstringRequired
account_idstringRequired

Request

This endpoint expects an object.
namestring or nullOptional<=255 characters
Route name
descriptionstring or nullOptional
Route description
processorslist of objects or nullOptional
Ordered list of processors
statusenum or nullOptional

Route lifecycle status. An inactive route is skipped by the charge path: a checkout session or cascade tier that names it falls back to the account default, and it cannot be set as the account default or referenced by an active routing rule. Changing only the status does not create a new route version.

Allowed values:
expected_versioninteger or nullOptional

Optional optimistic-concurrency check. When set, the update is refused with 409 unless it matches the route's current version -- the same field this response returns. Lets a client that fetched the route before editing detect a concurrent edit instead of silently overwriting it. Omit to update unconditionally, as before.

Response

Successful Response
idstring
Unique route identifier
namestring
Route name
processorslist of objects
Ordered list of processors
versioninteger
Current route version. Increments on each configuration edit.
statusenum
Route lifecycle status
Allowed values:
typeenum
Routing type
Allowed values:
created_atdatetime
When the route was created
updated_atdatetime
When the route was last updated
descriptionstring or nullOptional
Route description

Errors

422
Unprocessable Entity Error