Update Recurring Payment

Updating recurring payments allows modifications to payment details, intervals, or amounts for ongoing subscriptions or services. This guide refers to making changes to the specifics of an already-existing regular payment plan, including altering the amounts, intervals, or related data.

Tip

Updating an invoice can be used to update a payment method and catch up on any missed payments caused by an invalid payment method. If you want to update any other fields, you will need to cancel the recurring payment and create a new one.

Request

This call will allow you to update the payment method on a recurring payment and catch up on any missed payments caused by an invalid payment method.

GraphQL

mutation {
	updateRecurringPayment(input: {
        payment_method_id: "", # Insert payment_method_id
        recurring_id: "", # Insert recurring_id
    })
    {
        amount_per_payment
        remaining_payments
        recurring_id
    }
}

Additional Parameters

View the extensive list of parameters for recurring payments in our API.

View All Parameters

---

Return

The call will return the updated recurring payment object.

JSON

{
    "data": {
        "updateRecurringPayment": {
            "amount_per_payment": 100,
            "remaining_payments": 10,
            "recurring_id": "pt_rec_123456789"
        }
    }
}

---

Next Steps

You always have the option to create new recurring payments pertaining to recurring payments as well as cancel the recurring payments.