GET

/v1/recurring-billing

X-BUSINESS-API-KEY*
X-Requested-With
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/recurring-billing \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "status": "200",
  "example": "{\n    \"data\": [\n        {\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\": null,\n            \"times_charged\": null,\n            \"status\": \"active\",\n            \"send_email\": 0,\n            \"save_card\": 0,\n            \"redirect_url\": \"https://github.com/\",\n            \"payment_methods\": [\n                \"giro\",\n                \"card\"\n            ],\n            \"created_at\": \"2022-09-09T11:29:05\",\n            \"updated_at\": \"2022-09-09T11:29:05\",\n            \"expires_at\": \"2022-11-11T23:59:59\",\n            \"url\": \"https://securecheckout.sandbox.hit-pay.com/9673bdea-058c-44b5-a957-845a7c487bc2/recurring-plan/97389d64-3852-426e-9a37-87372ddd1c95\",\n            \"webhook\": null\n        },\n        {\n            \"id\": \"97389135-3817-4831-94f9-ae3e0611444e\",\n            \"business_recurring_plans_id\": \"97389114-f210-4db2-904b-001035f45abc\",\n            \"customer_name\": \"Anna\",\n            \"customer_email\": \"anna@hitpayapp.com\",\n            \"name\": \"Spotify Premium\",\n            \"description\": \"Spotify Monthly Subscription\",\n            \"reference\": \"cust_id_1234\",\n            \"cycle\": \"monthly\",\n            \"cycle_repeat\": null,\n            \"cycle_frequency\": null,\n            \"currency\": \"sgd\",\n            \"price\": 9.90,\n            \"amount\": 9.90,\n            \"times_to_be_charged\": null,\n            \"times_charged\": null,\n            \"status\": \"active\",\n            \"send_email\": 0,\n            \"save_card\": 0,\n            \"redirect_url\": \"https://examaple.com/completed\",\n            \"payment_methods\": [\n                \"giro\",\n                \"card\"\n            ],\n            \"created_at\": \"2022-09-09T10:55:01\",\n            \"updated_at\": \"2022-09-09T10:55:01\",\n            \"expires_at\": \"2022-11-11T23:59:59\",\n            \"url\": \"https://securecheckout.sandbox.hit-pay.com/9673bdea-058c-44b5-a957-845a7c487bc2/recurring-plan/97389135-3817-4831-94f9-ae3e0611444e\",\n            \"webhook\": null\n        },\n        {\n            \"id\": \"9708a518-13c4-4082-a501-fe1bd7f0ca15\",\n            \"business_recurring_plans_id\": null,\n            \"customer_name\": \" Olivia\",\n            \"customer_email\": \"olivia@hitpayapp.com\",\n            \"name\": \"Spotify Premium\",\n            \"description\": \"Spotify Monthly Subscriptiond\",\n            \"reference\": null,\n            \"cycle\": \"monthly\",\n            \"cycle_repeat\": null,\n            \"cycle_frequency\": null,\n            \"currency\": \"sgd\",\n            \"amount\": 9.90,\n            \"times_to_be_charged\": null,\n            \"times_charged\": null,\n            \"status\": \"active\",\n            \"send_email\": 0,\n            \"save_card\": 0,\n            \"redirect_url\": null,\n            \"payment_methods\": [\n                \"card\",\n                \"giro\"\n            ],\n            \"created_at\": \"2022-08-16T15:10:53\",\n            \"updated_at\": \"2022-08-16T15:10:53\",\n            \"expires_at\": \"2022-09-19T23:59:59\",\n            \"url\": \"https://securecheckout.sandbox.hit-pay.com/9673bdea-058c-44b5-a957-845a7c487bc2/recurring-plan/9708a518-13c4-4082-a501-fe1bd7f0ca15\",\n            \"webhook\": null\n        }\n    ],\n    \"links\": {\n        \"first\": \"https://api.sandbox.hit-pay.com/v1/recurring-billing?page=1\",\n        \"last\": \"https://api.sandbox.hit-pay.com/v1/recurring-billing?page=1\",\n        \"prev\": null,\n        \"next\": null\n    },\n    \"meta\": {\n        \"current_page\": 1,\n        \"from\": 1,\n        \"last_page\": 1,\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"&laquo; Previous\",\n                \"active\": false\n            },\n            {\n                \"url\": \"https://api.sandbox.hit-pay.com/v1/recurring-billing?page=1\",\n                \"label\": \"1\",\n                \"active\": true\n            },\n            {\n                \"url\": null,\n                \"label\": \"Next &raquo;\",\n                \"active\": false\n            }\n        ],\n        \"path\": \"https://api.sandbox.hit-pay.com/v1/recurring-billing\",\n        \"per_page\": 15,\n        \"to\": 3,\n        \"total\": 3,\n        \"status\": [\n            \"active\"\n        ]\n    }\n}"
}

Authorizations

X-BUSINESS-API-KEYheaderrequired
string

Headers

X-Requested-With
Default: "XMLHttpRequest"
string

Query Parameters

customer_email
string

Customer Email

reference
string

Reference number

business_recurring_plans_id
string

Recurring Plan ID

status
Default: "active"
string

Recurring billing status, options [active, scheduled, canceled]

Response

200 - application/json
data
object[]
links
object
meta
object