Use this API to update the recurring billing, any changes made to the cycle will only be effective at the end of the current cycle.
curl --request PUT \
--url https://api.sandbox.hit-pay.com/v1/recurring-billing/{recurring_billing_id} \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"plan_id": "973ee344-6737-4897-9929-edbc9d7bf433",
"name": "Spotify Premium",
"description": "Spotify Monthly Subscription",
"payment_methods": [
"card"
],
"cycle": "weekly",
"cycle_repeat": 500,
"cycle_frequency": "day",
"save_card": "true",
"customer_email": "abc@gmail.com",
"customer_name": "Paul",
"start_date": "2025-12-31",
"redirect_url": "<string>",
"reference": "<string>",
"amount": 123,
"webhook": "<string>",
"send_email": "false"
}'
"{\n \"id\": \"9741164c-06a1-4dd7-a649-72cca8f9603a\",\n \"business_recurring_plans_id\": \"973ee344-6737-4897-9929-edbc9d7bf433\",\n \"customer_name\": \"Paul\",\n \"customer_email\": \"paul@newemail.com\",\n \"name\": \"Spotify Premium\",\n \"description\": \"Spotify Monthly Subscription\",\n \"reference\": \"cust_id_123\",\n \"cycle\": \"monthly\",\n \"cycle_repeat\": null,\n \"cycle_frequency\": null,\n \"currency\": \"sgd\",\n \"amount\": 12.9,\n \"times_to_be_charged\": 9,\n \"times_charged\": 2,\n \"status\": \"active\",\n \"send_email\": 0,\n \"save_card\": 0,\n \"redirect_url\": \"https://newexamaple.com/completed\",\n \"payment_methods\": [\n \"giro\",\n \"card\"\n ],\n \"created_at\": \"2022-09-13T21:32:00\",\n \"updated_at\": \"2022-09-13T21:32:00\",\n \"expires_at\": null,\n \"url\": \"https://securecheckout.sandbox.hit-pay.com/973ee344-6737-4897-9929-edbc9d7bf433/recurring-plan/9741164c-06a1-4dd7-a649-72cca8f9603a\",\n \"webhook\": \"http://newwebhoo.site/test\"\n}"
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
id value from the create recurring billing API
200
The response is of type object
.
curl --request PUT \
--url https://api.sandbox.hit-pay.com/v1/recurring-billing/{recurring_billing_id} \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"plan_id": "973ee344-6737-4897-9929-edbc9d7bf433",
"name": "Spotify Premium",
"description": "Spotify Monthly Subscription",
"payment_methods": [
"card"
],
"cycle": "weekly",
"cycle_repeat": 500,
"cycle_frequency": "day",
"save_card": "true",
"customer_email": "abc@gmail.com",
"customer_name": "Paul",
"start_date": "2025-12-31",
"redirect_url": "<string>",
"reference": "<string>",
"amount": 123,
"webhook": "<string>",
"send_email": "false"
}'
"{\n \"id\": \"9741164c-06a1-4dd7-a649-72cca8f9603a\",\n \"business_recurring_plans_id\": \"973ee344-6737-4897-9929-edbc9d7bf433\",\n \"customer_name\": \"Paul\",\n \"customer_email\": \"paul@newemail.com\",\n \"name\": \"Spotify Premium\",\n \"description\": \"Spotify Monthly Subscription\",\n \"reference\": \"cust_id_123\",\n \"cycle\": \"monthly\",\n \"cycle_repeat\": null,\n \"cycle_frequency\": null,\n \"currency\": \"sgd\",\n \"amount\": 12.9,\n \"times_to_be_charged\": 9,\n \"times_charged\": 2,\n \"status\": \"active\",\n \"send_email\": 0,\n \"save_card\": 0,\n \"redirect_url\": \"https://newexamaple.com/completed\",\n \"payment_methods\": [\n \"giro\",\n \"card\"\n ],\n \"created_at\": \"2022-09-13T21:32:00\",\n \"updated_at\": \"2022-09-13T21:32:00\",\n \"expires_at\": null,\n \"url\": \"https://securecheckout.sandbox.hit-pay.com/973ee344-6737-4897-9929-edbc9d7bf433/recurring-plan/9741164c-06a1-4dd7-a649-72cca8f9603a\",\n \"webhook\": \"http://newwebhoo.site/test\"\n}"