PUT
/
v1
/
recurring-billing
/
{recurring_billing_id}
Update Recurring Billing
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}"

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
recurring_billing_id
string<uuid>
required

id value from the create recurring billing API

Body

application/json
​
plan_id
string<uuid>

The plan ID, if plan_id is not null it will update [cycle, cycle_repeat, cycle_frequency and amount] with the values from Subscription plan. if plan_id is null you can update each field individually. When save_card is true, you disallow to set plan_id

Example:

"973ee344-6737-4897-9929-edbc9d7bf433"

​
name
string

Plan name

Maximum length: 255
Example:

"Spotify Premium"

​
description
string

The description of subscription plan

Example:

"Spotify Monthly Subscription"

​
payment_methods
enum<string>[]

The active Payment methods to be used for the subscription: card, giro, shopee_recurring.

Example:
["card"]
​
cycle
enum<string>

Billing frequency (weekly / monthly / yearly / custom)

Available options:
weekly,
monthly,
yearly,
custom
​
cycle_repeat
integer

It is required field when cycle is custom. New cycle will only be affective at the end of the current cycle

Required range: 1 <= x <= 999
​
cycle_frequency
enum<string>

It is required field when the cycle is custom. For cycle = custom, set the frequency for cycle repeat field options [day, week, month, year]

Available options:
day,
week,
month,
year
​
save_card
enum<string>

Only set the value “true” if you wish to save the card and charge the customer later on. More details in “Save Card” section

Available options:
true,
false
​
customer_email
string<email>

Customer's email.

Example:

"abc@gmail.com"

​
customer_name
string

Customer's name.

Maximum length: 255
Example:

"Paul"

​
start_date
string

The start date must be a date after or equal to today and Billing start date (YYYY-MM-DD) in SGT, only possible to change start date for recurring billing ID with status = scheduled or active

Example:

"2025-12-31"

​
redirect_url
string<url>

URL where HitPay redirects the user after the users enters the card details and the subscription is active. Query arguments reference (subscription id) and status are sent along

​
reference
string

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer

Maximum length: 255
​
amount
number

New amount, customer will be charged the new amount on the next cycle. Min: It depends on the currency, Max 999999.99

Required range: x <= 999999.9
​
webhook
string<url>

Optional URL value to which HitPay will send a POST request when there is a new charge or if there is an error charging the card

​
send_email
enum<string>
default:false

Send the email

Available options:
true,
false

Response

200

​
id
string
Examples:

"9741164c-06a1-4dd7-a649-72cca8f9603a"

​
business_recurring_plans_id
string
Examples:

"973ee344-6737-4897-9929-edbc9d7bf433"

​
customer_name
string
Examples:

"Paul"

​
customer_email
string
Examples:

"paul@newemail.com"

​
name
string
Examples:

"Spotify Premium"

​
description
string
Examples:

"Spotify Monthly Subscription"

​
reference
string
Examples:

"cust_id_123"

​
cycle
string
Examples:

"monthly"

​
cycle_repeat
any
​
cycle_frequency
any
​
currency
string
Examples:

"sgd"

​
amount
number
default:0
Examples:

12.9

​
times_to_be_charged
integer
default:0
Examples:

9

​
times_charged
integer
default:0
Examples:

2

​
status
string
Examples:

"active"

​
send_email
integer
default:0
Examples:

0

​
save_card
integer
default:0
Examples:

0

​
redirect_url
string
Examples:

"https://newexamaple.com/completed"

​
payment_methods
string[]
​
created_at
string
Examples:

"2022-09-13T21:32:00"

​
updated_at
string
Examples:

"2022-09-13T21:32:00"

​
expires_at
any
​
url
string
Examples:

"https://securecheckout.sandbox.hit-pay.com/973ee344-6737-4897-9929-edbc9d7bf433/recurring-plan/9741164c-06a1-4dd7-a649-72cca8f9603a"

​
webhook
string
Examples:

"http://newwebhoo.site/test"