Update a payment plan

put

https://test-api.payology.io/customer-vault/api/v1/payment-plan/{token}

Update exactly one primary field: org_bank_account_token, terminal_token or status. status accepts Inactive only. bypass_webhook may accompany that change. This operation does not edit amounts/dates or reactivate a schedule. Destination compatibility and access are checked by the service.

Request examples

Deactivate

PUT /customer-vault/api/v1/payment-plan/66666666-6666-4666-8666-666666666666 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: application/json

ACHDestination

PUT /customer-vault/api/v1/payment-plan/66666666-6666-4666-8666-666666666666 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: application/json

CCDestination

PUT /customer-vault/api/v1/payment-plan/66666666-6666-4666-8666-666666666666 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: application/json

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
200	R0000	Ok	The request was processed successfully
400	R0002	Error	Field is not properly formatted
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0010	Error	Payment Plan token is invalid
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

token

string

required

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Payment-plan UUID.

Body Params

JSON request body. Required and conditional fields are defined by the schema. Named examples show supported request variants.

org_bank_account_token

uuid

required

UUID of the accessible organization bank account used for this operation.

terminal_token

uuid

UUID of the accessible CC processing terminal. Schedules use this instead of org_bank_account_token.

bypass_webhook

boolean

When true, suppress the webhook associated with this operation where supported. This does not change the payment processing outcome.

status

string

enum

Lifecycle or processing status of the surrounding resource. Allowed values depend on the operation.

Allowed:

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

200Payment Plan updated.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

404Requested resource or lookup reference was not found.

413Possible gateway request size rejection. Service-specific limits and response templates require environment verification.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.