Get plans

GET

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
      }
    }
  ]
}

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.

data.id

string

required

Plan ID.

Example:

"plan_zHmjoDea4ZRmQV"

data.name

string

required

Plan name.

Example:

"Starter"

data.description

string | null

required

Plan description.

Example:

"Starter pack"

data.commitment_interval

object | null

required

Interval used to represent the commitment period of the plan.

Example:

{ "period": "years", "count": 1 }

data.contract_start_strategy

enum<string>

required

Strategy used to trigger the start of the subscription contract.

Available options:

start_date,

immediately,

manual,

manual_with_latest,

quote_signature,

checkout

Example:

"start_date"

data.contract_start

string | null

required

Contract start date, applicable if the start strategy is start_date.

Example:

"2025-01-01T00:00:00.000Z"

data.contract_end_strategy

enum<string>

required

Strategy used to trigger the end of the subscription contract.

Available options:

duration,

manual,

end_date

Example:

"duration"

data.contract_end

string | null

required

Contract end date, applicable if the end strategy is end_date.

Example:

"2025-12-31T23:59:59.999Z"

data.contract_duration

object | null

required

Duration of the initial contract for the created subscription.

Example:

{ "period": "years", "count": 1 }

data.renew_automatically

boolean

required

Indicates if the subscription to the plan should automatically renew.

Example:

true

data.renew_for

object | null

required

Interval to renew thr subscription for if renew_automatically is enabled.

Example:

{ "period": "years", "count": 1 }

Create payment Get plan

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
      }
    }
  ]
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Query Parameters

Response