DELETE
/
v1
/
recurring-billing
/
{recurring_billing_id}
curl --request DELETE \
  --url https://api.sandbox.hit-pay.com/v1/recurring-billing/{recurring_billing_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
"{\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@hitpayapp.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\": 9.90,\n    \"times_to_be_charged\": 3,\n    \"times_charged\": 0,\n    \"status\": \"canceled\",\n    \"send_email\": false,\n    \"save_card\": 0,\n    \"redirect_url\": \"https://github.com/\",\n    \"payment_methods\": [\n        \"giro\",\n        \"card\"\n    ],\n    \"created_at\": \"2022-09-13T16:33:47\",\n    \"updated_at\": \"2022-09-13T16:33:47\",\n    \"expires_at\": \"2022-11-11T23:59:59\",\n    \"url\": \"https://securecheckout.sandbox.hit-pay.com/973ee344-6737-4897-9929-edbc9d7bf433/recurring-plan/9741164c-06a1-4dd7-a649-72cca8f9603a\",\n    \"webhook\": \"https://webhoo.site/test\"\n}"

Headers

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

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
recurring_billing_id
string
required

Response

200
application/json
200
​
id
string
Example:

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

​
business_recurring_plans_id
string
Example:

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

​
customer_name
string
Example:

"Paul"

​
customer_email
string
Example:

"paul@hitpayapp.com"

​
name
string
Example:

"Spotify Premium"

​
description
string
Example:

"Spotify Monthly Subscription"

​
reference
string
Example:

"cust_id_123"

​
cycle
string
Example:

"monthly"

​
cycle_repeat
any
​
cycle_frequency
any
​
currency
string
Example:

"sgd"

​
amount
number
default:0
Example:

9.9

​
times_to_be_charged
integer
default:0
Example:

3

​
times_charged
integer
default:0
Example:

0

​
status
string
Example:

"canceled"

​
send_email
boolean
default:true
Example:

false

​
save_card
integer
default:0
Example:

0

​
redirect_url
string
Example:

"https://github.com/"

​
payment_methods
string[]
​
created_at
string
Example:

"2022-09-13T16:33:47"

​
updated_at
string
Example:

"2022-09-13T16:33:47"

​
expires_at
string
Example:

"2022-11-11T23:59:59"

​
url
string
Example:

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

​
webhook
string
Example:

"https://webhoo.site/test"

Was this page helpful?

Get All Recurring BillingCharge the saved card