---
updatedAt: 2026-08-18T05:00:34.000Z
agentTools:
  projectIndex: https://docs.paymongo.com/llms.txt
---

# Update a repeating invoice's customer email

Changes the email future cycles bill to. The only patchable field - cadence, amount, and schedule are frozen at registration. A foreign or cross-mode id reads as 404.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "name": "Payment Channels Team"
    },
    "title": "Invoices",
    "version": "1.0.0",
    "summary": "PayMongo's sales invoicing service: create, send, and collect invoices with hosted payment pages and PDFs.",
    "description": "Owns the sales-invoice lifecycle: drafting, sending (with a hosted checkout\nsession + customer email), reminders, voiding, out-of-band settlement,\nbulk CSV imports, per-org branding, and on-demand PDF rendering. It is the\nsystem of record for `si_*` invoices and `sili_*` line items. Called by the\nPayMongo Dashboard (merchant Basic auth), the public hosted invoice page\n(unauthenticated by-slug capability URLs), and internal PayMongo services\nsuch as the Employee Dashboard and subscriptions (internal API key).\n",
    "license": {
      "name": "PayMongo Internal",
      "identifier": "LicenseRef-PayMongo-Internal"
    },
    "x-paymongo-service-slug": "invoices-api",
    "x-paymongo-service-tier": "tier-2",
    "x-paymongo-owner-slack": "#invoices-api-alerts-eng-prd",
    "x-paymongo-repo": "https://github.com/paymongo/invoices-api",
    "x-paymongo-data-classification": "financial"
  },
  "servers": [
    {
      "url": "https://invoices-api.paymongo.com",
      "description": "Production"
    },
    {
      "url": "https://invoices-api.paymongo-uat.com",
      "description": "UAT"
    },
    {
      "url": "https://invoices-api.paymongo-stg.com",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "Invoices",
      "description": "Invoice lifecycle: create, list, retrieve, update, send, remind, void, export, summary, and PDF rendering."
    }
  ],
  "paths": {
    "/v1/invoices/recurring/{id}": {
      "patch": {
        "description": "Changes the email future cycles bill to. The only patchable field - cadence, amount, and schedule are frozen at registration. A foreign or cross-mode id reads as 404.",
        "parameters": [
          {
            "description": "Recurring registration ID",
            "example": "inrec_abc123",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateRecurringEmailRequestDTO"
              }
            }
          },
          "description": "New customer email",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseRootDTO"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/RecurringResponseDTO"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestErrorResponseRootDTO"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedErrorResponseRootDTO"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundErrorResponseRootDTO"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConflictErrorResponseRootDTO"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerErrorResponseRootDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "BasicAuth": []
          }
        ],
        "summary": "Update a repeating invoice's customer email",
        "tags": [
          "Invoices"
        ],
        "operationId": "update_invoices_recurring"
      }
    }
  },
  "components": {
    "schemas": {
      "BadRequestErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "invalid_request_body",
                  "type": "string"
                },
                "detail": {
                  "example": "Parameter customer_email must be a valid email address",
                  "type": "string"
                },
                "source": {
                  "properties": {
                    "pointer": {
                      "example": "/customer_email",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ConflictErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "not_allowed",
                  "type": "string"
                },
                "detail": {
                  "example": "the import is no longer editable",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "InternalServerErrorResponseRootDTO": {
        "properties": {
          "error_id": {
            "example": "err_a1b2c3d4e5f6",
            "type": "string"
          },
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "internal_server_error",
                  "type": "string"
                },
                "detail": {
                  "example": "Something went wrong on our end. Please try again, and share the error ID below if it keeps happening.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "NotFoundErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "not_found",
                  "type": "string"
                },
                "detail": {
                  "example": "We couldn't find that invoice. It may have been deleted.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ResponseRootDTO": {
        "description": "Standard response containing data and its metadata if any",
        "properties": {
          "data": {},
          "has_more": {
            "example": true,
            "type": "boolean"
          },
          "page": {
            "example": 1,
            "type": "integer"
          },
          "page_count": {
            "example": 5,
            "type": "integer"
          },
          "per_page": {
            "example": 10,
            "type": "integer"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "UnauthorizedErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "unauthorized",
                  "type": "string"
                },
                "detail": {
                  "example": "Authentication is required or the provided credentials are invalid.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "RecurringResponseDTO": {
        "properties": {
          "agreement_id": {
            "example": "ag_abc123",
            "type": "string"
          },
          "amount": {
            "example": 150000,
            "type": "integer"
          },
          "anchor_at": {
            "description": "AnchorAt is the first-cycle instant for a merchant (send-mode)\nregistration; null for a delegated one.",
            "example": "2026-09-01 01:00:00+00:00",
            "type": "string"
          },
          "cadence": {
            "example": "monthly",
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "currency": {
            "example": "PHP",
            "type": "string"
          },
          "customer_email": {
            "example": "juan@example.com",
            "type": "string"
          },
          "customer_id": {
            "example": "cus_abc123",
            "type": "string"
          },
          "customer_name": {
            "example": "Juan dela Cruz",
            "type": "string"
          },
          "cycle_count": {
            "example": 12,
            "type": "integer"
          },
          "cycles_generated": {
            "example": 3,
            "type": "integer"
          },
          "delivery_mode": {
            "description": "DeliveryMode is delegated | send | charge; charge is executed off-session\nby this service. Merchant registrations are always send.",
            "example": "send",
            "type": "string"
          },
          "description": {
            "example": "Pro plan subscription",
            "type": "string"
          },
          "id": {
            "example": "inrec_abc123",
            "type": "string"
          },
          "interval_count": {
            "example": 3,
            "type": "integer"
          },
          "live_mode": {
            "example": true,
            "type": "boolean"
          },
          "next_run_at": {
            "description": "NextRunAt is the next cycle's instant (null unless active): the anchor\nbefore the first cycle, else the cadence's next due instant past the last generated cycle.",
            "example": "2026-10-01 01:00:00+00:00",
            "type": "string"
          },
          "organization_id": {
            "example": "org_abc123",
            "type": "string"
          },
          "payment_method_ref": {
            "example": "pm_abc123",
            "type": "string"
          },
          "payment_methods": {
            "description": "PaymentMethods is frozen at registration and stamped onto every cycle\ninvoice.",
            "example": [
              "card",
              "gcash"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "status": {
            "example": "active",
            "type": "string"
          },
          "subscription_id": {
            "example": "sub_abc123",
            "type": "string"
          },
          "trigger_id": {
            "example": "tr-abc123",
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "workflow_id": {
            "example": "flow-abc123",
            "type": "string"
          }
        },
        "type": "object"
      },
      "UpdateRecurringEmailRequestDTO": {
        "properties": {
          "customer_email": {
            "example": "juan@example.com",
            "type": "string"
          }
        },
        "required": [
          "customer_email"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Merchant API authentication: HTTP Basic with the organization's secret\nkey (`sk_...`) as the username and a blank password — the same scheme as\nthe core PayMongo API. Resolved to the caller's organization; supports\nlinked-account delegation via the AccountID middleware.\n"
      }
    }
  }
}
```