GET
/
v1
/
plans
curl --request GET \
  --url https://api.hyperline.co/v1/plans \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "plan_zHmjoDea4ZRmQV",
      "name": "Starter",
      "description": "Starter pack",
      "commitment_interval": {
        "period": "years",
        "count": 1
      },
      "contract_start_strategy": "start_date",
      "contract_start": "2025-01-01T00:00:00.000Z",
      "contract_end_strategy": "duration",
      "contract_end": "2025-12-31T23:59:59.999Z",
      "contract_duration": {
        "period": "years",
        "count": 1
      },
      "renew_automatically": true,
      "renew_for": {
        "period": "years",
        "count": 1
      },
      "trial_interval": {
        "period": "months",
        "count": 1
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
take
number | null
default:
50
Required range: 0 < x < 100
​
skip
number | null
default:
0
Required range: x > 0

Response

200 - application/json
​
meta
object
required
​
data
object[]
required

List of Plan.

Was this page helpful?

Create paymentGet plan