Update payment plan
Use this method to partially update a payment plan. Structure your request to follow the RFC 6902 standard.
To update a payment plan, you need its paymentPlanId, which you sent in the request of the Create Payment Plan method.
Note: If you don’t have the paymentPlanId, use our List Payment Plans method to search for the payment plan.
You can update all of the properties of the payment plan except for the paymentPlanId.
The value you sent for the onUpdate parameter when you created the payment plan indicates what happens to the associated subscriptions when you update the plan:
update
- Our gateway updates the subscriptions associated with the payment plan.continue
- Our gateway doesn’t update the subscriptions associated with the payment plan.
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Request
Response
Indicates how the merchant takes the payment from the customer’s account.
manual
- The merchant manually collects payments from the customer.automatic
- The terminal automatically collects payments from the customer.
Indicates whether any changes that the merchant makes to the payment plan apply to existing subscriptions.
update
- Changes apply to existing subscriptions.continue
- Changes don’t apply to existing subscriptions.
Indicates what happens to existing subscriptions if the merchant deletes the payment plan.
complete
- Stops existing subscriptions.continue
- Continues existing subscriptions.
Object that contains information about the cost of each payment.
Note: Send this object only if the value for type is automatic
.
Number of payments for the payment plan.
To indicate that the payment plan should run indefinitely, send a value of 0
.