Skip to content

update_payment_policy

PATCH
/v1/payments/policies/{payment_policy_id}
payment_policy_id
required
string

Payment policy ID

object
allowed_capabilities
array | null
allowed_hosts
array | null
max_amount_usd_per_day
number | null format: double
max_amount_usd_per_request
number | null format: double
max_amount_usd_per_turn
number | null format: double
metadata
rail_preference
array | null
require_approval_above_usd
number | null format: double
status
string | null

Payment policy updated

object
allowed_capabilities
required
Array<string>
allowed_hosts
required
Array<string>
created_at
required
string format: date-time
id
required

Prefixed identifier with ‘paypol’ prefix

string
/^paypol_[0-9a-f]{32}$/
Example
paypol_01933b5a00007000800000000000001
max_amount_usd_per_day
number | null format: double
max_amount_usd_per_request
number | null format: double
max_amount_usd_per_turn
number | null format: double
metadata
required
organization_id
required
string
payment_account_id
required

Prefixed identifier with ‘payacct’ prefix

string
/^payacct_[0-9a-f]{32}$/
Example
payacct_01933b5a00007000800000000000001
rail_preference
required
Array<string>
Allowed values: mpp_tempo x402_base
require_approval_above_usd
number | null format: double
status
required
string
Allowed values: active disabled pending succeeded failed released
subject_id
required
string
subject_type
required
string
updated_at
required
string format: date-time

Invalid input

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string

Not found

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string