Create Recurring Billing

Create a recurring billing subscription for a customer

POST /v1/recurring-billing

Create Recurring Billing

cURL

curl --request POST \
  --url https://api.hit-pay.com/v1/recurring-billing \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "customer_email": "[e-mail]",
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "save_card": "false",
  "save_payment_method": "false",
  "start_date_method": null,
  "name": "Spotify Premium",
  "amount": 9.9,
  "cycle_repeat": 500,
  "customer_name": "Paul",
  "start_date": "2025-12-31",
  "redirect_url": "<string>",
  "reference": "<string>",
  "payment_methods": [
    "card"
  ],
  "send_email": "false",
  "times_to_be_charged": 1
}
'

200

This response has no body data.

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

customer_email · string<email> · required

Customer's email.

Example:

"[e-mail]"

plan_id · string<uuid>

Subscription plan id created from Create a Subscription Plan API. If you would like to create a subscription without a plan, plan_id should be null

save_card · enum<string> · default: false

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

save_payment_method · enum<string> · default: false

It's new field that will replace save_card field in the future. Only set the value “true” if you wish to save the payment method and charge the customer later on. More details in “Save Payment Method” section

Available options: true, false

start_date_method · enum<string>

It's an optional field and only applicable when save_payment_method is true. By default, the start_date_method is null. Options are sign_up_date or no_initial_charge

Available options: sign_up_date, no_initial_charge

name · string

It's is required when save card = true or plan_id = null. By default, the name from the subscription plan will be used.

Maximum string length: 255

Example:

"Spotify Premium"

amount · integer<double>

Required when save_card = true and plan_id = null for cards. By default, the amount from the subscription plan will be used. Optional when payment_methods contains only APMs (zalopay, shopee_pay, grabpay_direct, touch_n_go) and save_payment_method is true. Min: It depends on the currency, Max: 999999.99.

Required range: x <= 999999.99

Example:

9.9

cycle · enum<string>

It's is required when plan_id = null. By default, the cycle from the subscription plan will be used. 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

customer_name · string

Customer's name.

Maximum string length: 255

Example:

"Paul"

start_date · string

Required when save_card is not true. Billing start date (YYYY-MM-DD) in SGT. Must be today or a future date.

Example:

"2025-12-31"

redirect_url · string

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

Maximum string length: 255

payment_methods · enum<string>[]

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

Available options: card, giro, shopee_recurring

Example:

["card"]

send_email · enum<string> · default: false

HitPay to send email receipts to the customer. Default value is false

Available options: true, false

times_to_be_charged · number · default: 1

It's time to be charged. Default value is 1

Required range: 1 <= x <= 100

Example:

1

Response

200