Create Recurring Customer
Creates a recurring payment customer. The customer binds their card on the RM-hosted page, after which RM automatically charges them on your defined schedule (weekly or monthly).
When to Use
▾
Use this endpoint when:
- Building a subscription with automated recurring billing
- You want RM to handle the schedule (no need to call charge yourself)
How to Use
▾
/v3/recurring-paymentStep 1: Define the Schedule
▾
Choose recurringInterval (WEEKLY / MONTHLY), recurringTarget (day), and recurringRepetition (total charges).
Step 2: Create the Customer
▾
POST customer + product + schedule. RM returns a paymentUrl for card binding.
Step 3: Send the Customer to Bind
▾
Redirect to paymentUrl. After binding, RM auto-charges on the configured schedule.
Request Parameters
▾
Revenue Monster Store ID
Customer email address
Customer name
Customer country code
Example: "60"
Customer phone number
Recurring product name
Recurring product description
Recurring payment currency
Example: "MYR"
Recurring payment amount in smallest currency unit
URL to redirect the customer to after card binding
Server URL to receive payment notifications
Recurring interval (WEEKLY, MONTHLY)
Day of the week or month to charge. See recurring target rules below.
Number of times to charge the customer
Recurring Target Rules
▾
| Interval | Target | Payment Behaviour |
|---|---|---|
WEEKLY | 0 | Every Sunday |
WEEKLY | 1 | Every Monday |
WEEKLY | 2 | Every Tuesday |
WEEKLY | 3 | Every Wednesday |
WEEKLY | 4 | Every Thursday |
WEEKLY | 5 | Every Friday |
WEEKLY | 6 | Every Saturday |
MONTHLY | -1 | End of every month |
MONTHLY | 0 | Start of every month |
MONTHLY | 1–28 | Day of the month |
Response Parameters
▾
Response item
Recurring payment ID
Merchant ID
Store ID
Customer card: front six and last four digits
Customer email
Customer country code
Customer phone number
Recurring product name
Recurring product description
Whether the recurring payment is active. Becomes true after card is bound successfully.
Recurring created date time
Recurring last updated date time
Internal usage only
URL for customer to redirect after card binding
URL for payment notifications
URL for customer to bind their card
recurringPayment details
Recurring payment amount
Recurring payment currency
Recurring interval
Recurring target rules
Number of repetitions
"SUCCESS" if the request succeeded, otherwise an error code.
Error details
Error code if the request failed.
Error message if the request failed.
Debug message (sandbox only).