GET
/
v1
/
recurring-billing
/
{recurring_billing_id}
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/recurring-billing/{recurring_billing_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "id": "9ad461a8-47ec-4f95-aeb3-1a3d16fec521",
  "business_recurring_plans_id": null,
  "customer_name": "API_Save_Card_1702369621",
  "customer_email": "test@gmail.com",
  "customer_phone_number": null,
  "customer_phone_number_country_code": null,
  "name": "API_Save_Card_New_1702369621",
  "description": "description_1702369621",
  "reference": "cust_id_123",
  "cycle": "save_card",
  "cycle_repeat": null,
  "cycle_frequency": null,
  "currency": "usd",
  "price": 94.27,
  "amount": 94.27,
  "times_to_be_charged": null,
  "times_charged": null,
  "status": "canceled",
  "send_email": 1,
  "save_card": 1,
  "redirect_url": "https://www.google.com/",
  "payment_methods": [
    "giro",
    "card"
  ],
  "payment_provider_charge_method": "card",
  "created_at": "2023-12-12T16:27:01",
  "updated_at": "2023-12-13T09:33:02",
  "pause_from": null,
  "pause_until": null,
  "expires_at": null,
  "url": "https://securecheckout.staging.hit-pay.com/98567029-f559-49f9-916b-042a4255b32a/recurring-plan/9ad461a8-47ec-4f95-aeb3-1a3d16fec521",
  "webhook": "https://webhook.site/3ba5a485-b46e-4c44-ac3c-ae5469f90bbe",
  "webhook_retry_count": 0,
  "webhook_last_attempt": null,
  "dbs_dda_reference": "RP94OH2LYZY",
  "total_charge": 0,
  "payment_method": {
    "card": {
      "brand": "visa",
      "last4": "4242"
    }
  }
}

Headers

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

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
recurring_billing_id
string
required

Response

200
application/json
200
​
id
string
​
business_recurring_plans_id
any
​
customer_name
string
​
customer_email
string
​
customer_phone_number
any
​
customer_phone_number_country_code
any
​
name
string
​
description
string
​
reference
string
​
cycle
string
​
cycle_repeat
any
​
cycle_frequency
any
​
currency
string
​
price
number
​
amount
number
​
times_to_be_charged
any
​
times_charged
any
​
status
string
​
send_email
number
​
save_card
number
​
redirect_url
string
​
payment_methods
string[]
​
payment_provider_charge_method
string
​
created_at
string
​
updated_at
string
​
pause_from
any
​
pause_until
any
​
expires_at
any
​
url
string
​
webhook
string
​
webhook_retry_count
number
​
webhook_last_attempt
any
​
dbs_dda_reference
string
​
total_charge
number
​
payment_method
object

Was this page helpful?