Invoices

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.

patch/v1/invoices/recurring/{id}

Request

Base URL
https://invoices-api.paymongo.com
URL
https://invoices-api.paymongo.com/v1/invoices/recurring/{id}
Auth
HTTP basic

Path parameters

idstring required

Recurring registration ID

Request body

customer_emailstring required

Example request

{
  "customer_email": "juan@example.com"
}

Response

has_moreboolean

pageinteger

page_countinteger

per_pageinteger

totalinteger

Example response

{
  "data": {
    "agreement_id": "ag_abc123",
    "amount": 150000,
    "anchor_at": "2026-09-01T01:00:00Z",
    "cadence": "monthly",
    "currency": "PHP",
    "customer_email": "juan@example.com",
    "customer_id": "cus_abc123",
    "customer_name": "Juan dela Cruz",
    "cycle_count": 12,
    "cycles_generated": 3,
    "delivery_mode": "send",
    "description": "Pro plan subscription",
    "id": "inrec_abc123",
    "interval_count": 3,
    "live_mode": true,
    "next_run_at": "2026-10-01T01:00:00Z",
    "organization_id": "org_abc123",
    "payment_method_ref": "pm_abc123",
    "payment_methods": [
      "card",
      "gcash"
    ],
    "status": "active",
    "subscription_id": "sub_abc123",
    "trigger_id": "tr-abc123",
    "workflow_id": "flow-abc123"
  },
  "has_more": true,
  "page": 1,
  "page_count": 5,
  "per_page": 10,
  "total": 42
}

Changes

No recorded changes to this operation across all 1 revision of this API.