v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get All Subscription Plan

Use this API to get all subscription plans details.

get/v1/subscription-plan

Query parameters

per_pagenumber

The number of per page

pagenumber

The page index

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

Example response

{
  "data": [
    {
      "id": "975b1909-38f6-44f3-a0b1-c198b7478978",
      "name": "subscription-plan_new_1664175178",
      "description": "New_Description_1664175178",
      "cycle": "custom",
      "cycle_repeat": 1,
      "cycle_frequency": "day",
      "currency": "sgd",
      "price": 123.45,
      "amount": 123.45,
      "created_at": "2022-09-26T14:52:58",
      "updated_at": "2022-09-26T14:52:58"
    }
  ],
  "links": {
    "first": "https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1",
    "last": "https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "« Previous"
      }
    ],
    "path": "https://api.sandbox.hit-pay.com/v1/subscription-plan",
    "per_page": 25,
    "to": 2,
    "total": 2
  }
}