List Subscription Plans

List all subscription plans

GET /v1/subscription-plan

Get All Subscription Plan

cURL

curl --request GET \
  --url https://api.hit-pay.com/v1/subscription-plan \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

import requests

url = "https://api.hit-pay.com/v1/subscription-plan"

headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/subscription-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hit-pay.com/v1/subscription-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BUSINESS-API-KEY: <x-business-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hit-pay.com/v1/subscription-plan"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hit-pay.com/v1/subscription-plan")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hit-pay.com/v1/subscription-plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

response = http.request(request)
puts response.read_body

200

"{\n    \"data\": [\n        {\n            \"id\": \"975b1909-38f6-44f3-a0b1-c198b7478978\",\n            \"name\": \"subscription-plan_new_1664175178\",\n            \"description\": \"New_Description_1664175178\",\n            \"cycle\": \"custom\",\n            \"cycle_repeat\": 1,\n            \"cycle_frequency\": \"day\",\n            \"currency\": \"sgd\",\n            \"price\": 123.45,\n            \"amount\": 123.45,\n            \"reference\": null,\n            \"created_at\": \"2022-09-26T14:52:58\",\n            \"updated_at\": \"2022-09-26T14:52:58\"\n        },\n        {\n            \"id\": \"97533e84-4f48-4625-83de-1d2b3e3ae17b\",\n            \"name\": \"subscription-plan_new_1663837869\",\n            \"description\": \"New_Description_1663837869\",\n            \"cycle\": \"custom\",\n            \"cycle_repeat\": 1,\n            \"cycle_frequency\": \"day\",\n            \"currency\": \"sgd\",\n            \"price\": 9999999.99,\n            \"amount\": 9999999.99,\n            \"reference\": null,\n            \"created_at\": \"2022-09-22T17:11:09\",\n            \"updated_at\": \"2022-09-22T17:11:09\"\n        }\n    ],\n    \"links\": {\n        \"first\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n        \"last\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?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\": \"« Previous\",\n                \"active\": false\n            },\n            {\n                \"url\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n                \"label\": \"1\",\n                \"active\": true\n            },\n            {\n                \"url\": null,\n                \"label\": \"Next »\",\n                \"active\": false\n            }\n        ],\n        \"path\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan\",\n        \"per_page\": 25,\n        \"to\": 2,\n        \"total\": 2\n    }\n}"

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

per_page · number · default: 20

The number of per page

page · number · default: 1

The page index

Response

200 - application/json

200

data · object[]

Show child attributes

links · object

Show child attributes

meta · object

Show child attributes