Update Recurring Billing
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.
Headers
Path Parameters
id value from the create recurring billing API
Body
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
Plan name
255Plan description
Billing frequency (weekly / monthly / yearly / custom)
weekly, monthly, yearly, custom It is required field when cycle is custom. New cycle will only be affective at the end of the current cycle. Min:1, Max: 999
It is required field when cycle is custom. For cycle = custom, set the frequency for cycle repeat field options [day, week, month, year]
day, week, month, year Only set the value “true” if you wish to save the card and charge the customer later on. More details in “Save Card” section
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
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
Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer
New amount, customer will be charged the new amount on the next cycle. Min: 0.01, Max 999999.99
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 the email
true, false Response
Was this page helpful?