Recurring Billing
Delete Recurring Billing
Use this API to cancel the recurring billing subscription
DELETE
/v1/recurring-billing/{business_recurring_plans_id}
X-BUSINESS-API-KEY*
X-Requested-With
curl --request DELETE \
--url https://api.sandbox.hit-pay.com/v1/recurring-billing/{business_recurring_plans_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\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}"
}
Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Path Parameters
business_recurring_plans_idrequired
string
Response
200 - application/json
amount
Default: "0"number
business_recurring_plans_id
string
created_at
string
currency
string
customer_email
string
customer_name
string
cycle
string
cycle_frequency
any
cycle_repeat
any
description
string
expires_at
string
id
string
name
string
payment_methods
string[]
redirect_url
string
reference
string
save_card
Default: "0"integer
send_email
Default: trueboolean
status
string
times_charged
Default: "0"integer
times_to_be_charged
Default: "0"integer
updated_at
string
url
string
webhook
string
curl --request DELETE \
--url https://api.sandbox.hit-pay.com/v1/recurring-billing/{business_recurring_plans_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\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}"
}