v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Delete Recurring Billing

Use this API to cancel the recurring billing subscription

delete/v1/recurring-billing/{recurring_billing_id}

Path parameters

recurring_billing_idstring uuid required

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring

business_recurring_plans_idstring

customer_namestring

customer_emailstring

namestring

descriptionstring

referencestring

cyclestring

{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:delete:responses:200:content:application/json:schema:properties:cycle_repeat","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:delete:responses:200:content:application/json:schema:properties:cycle_frequency","oasType":"schema","type":"unknown"}

currencystring

amountnumber

times_to_be_chargedinteger

times_chargedinteger

statusstring

send_emailboolean

save_cardinteger

redirect_urlstring

payment_methodsstring[]

created_atstring

updated_atstring

expires_atstring

urlstring

Example response

{
  "id": "9741164c-06a1-4dd7-a649-72cca8f9603a",
  "business_recurring_plans_id": "973ee344-6737-4897-9929-edbc9d7bf433",
  "customer_name": "Paul",
  "customer_email": "paul@hitpayapp.com",
  "name": "Spotify Premium",
  "description": "Spotify Monthly Subscription",
  "reference": "cust_id_123",
  "cycle": "monthly",
  "currency": "sgd",
  "amount": 9.9,
  "times_to_be_charged": 3,
  "status": "canceled",
  "redirect_url": "https://github.com/",
  "payment_methods": [
    "giro"
  ],
  "created_at": "2022-09-13T16:33:47",
  "updated_at": "2022-09-13T16:33:47",
  "expires_at": "2022-11-11T23:59:59",
  "url": "https://securecheckout.sandbox.hit-pay.com/973ee344-6737-4897-9929-edbc9d7bf433/recurring-plan/9741164c-06a1-4dd7-a649-72cca8f9603a"
}