Skip to main content
POST
/
v1
/
recurring-billing
Create Recurring Billing
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/recurring-billing \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "save_card": "false",
  "name": "Spotify Premium",
  "amount": 9.9,
  "cycle": "weekly",
  "cycle_repeat": 500,
  "cycle_frequency": "day",
  "customer_email": "abc@gmail.com",
  "customer_name": "Paul",
  "start_date": "2025-12-31",
  "redirect_url": "<string>",
  "reference": "<string>",
  "payment_methods": [
    "card"
  ],
  "webhook": "https://webhook.site/test",
  "send_email": "false",
  "times_to_be_charged": 1
}'

Headers

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

Body

application/json
​
customer_email
string<email>
required
Example:
​
customer_name
string
required
Maximum length: 255
Example:
​
start_date
string
required
Example:
​
plan_id
string<uuid>
​
save_card
enum<string>
default:false
Available options:
true,
false
​
name
string
Maximum length: 255
Example:
​
amount
integer
Required range: x <= 999999.99
Example:
​
cycle
enum<string>
Available options:
weekly,
monthly,
yearly,
custom
​
cycle_repeat
integer
Required range: 1 <= x <= 999
​
cycle_frequency
enum<string>
Available options:
day,
week,
month,
year
​
redirect_url
string
​
reference
string
Maximum length: 255
​
payment_methods
enum<string>[]
Example:
​
webhook
string<url>
Example:
​
send_email
enum<string>
default:false
Available options:
true,
false
​
times_to_be_charged
number
default:1
Required range: 1 <= x <= 100
Example: