PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

Register a repeating invoice

post
https://invoices-api.paymongo.com/v1/invoices/recurring

Creates a send-mode recurring registration for the caller's organization: the customer is emailed a payable checkout link on every cycle. start_date must be tomorrow or later in Asia/Manila; cycles send at a fixed 09:00 Manila, and for monthly and yearly cadences, day 29-31 anchors clamp to the 28th (weekly and daily keep the picked date).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Registration payload

integer
required

Amount is the per-cycle amount in centavos; frozen at registration.

string
enum
required
Allowed:
string

Currency is an ISO-4217 code; defaults to PHP when omitted.

string
required
string
string
required
integer
≥ 0

CycleCount bounds the number of cycles; 0 (the default) runs until cancelled.

string
required

Description becomes the single line item's name on each cycle invoice.

integer
1 to 10

IntervalCount multiplies the cadence unit ("every 3 months"); 1-10,
defaults to 1 when omitted.

payment_methods
array of strings
payment_methods
string
required

StartDate is the first cycle's date, YYYY-MM-DD in Asia/Manila. Must
name tomorrow or later there; cycles send at a fixed 09:00 Manila.

Headers
string

Optional replay protection: a double-click with the same key inside the claim window is rejected with 409 rather than creating a second schedule. List recurring registrations to find the one that was created. Max 255 characters.

Responses

Updated about 21 hours ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 21 hours ago

Did this page help you?