Skip to main content
GET
/
v1
/
plans
/
{id}
Get plan
curl --request GET \
  --url https://api.hyperline.co/v1/plans/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
  },
  "products": [
    {
      "id": "itm_3kXODDF42QXtnL",
      "name": "Product name",
      "description": "Product internal description",
      "description_display_interval_dates": true,
      "payment_interval": {
        "period": "months",
        "count": 1
      },
      "payment_schedule": "start",
      "type": "flat_fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123,
          "country": "all",
          "currency": "EUR",
          "id": "<string>"
        }
      ]
    }
  ],
  "custom_properties": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required

Plan ID.

Example:

"plan_zHmjoDea4ZRmQV"

​
name
string
required

Plan name.

Example:

"Starter"

​
description
string | null
required

Plan description.

Example:

"Starter pack"

​
commitment_interval
object
required

Interval used to represent the commitment period of the plan.

Example:
{ "period": "years", "count": 1 }
​
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"

​
contract_start
string<date-time> | null
required

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

Example:

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

​
contract_end_strategy
enum<string>
required

Strategy used to trigger the end of the subscription contract.

Available options:
duration,
manual,
end_date
Example:

"duration"

​
contract_end
string<date-time> | null
required

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

Example:

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

​
contract_duration
object
required

Duration of the initial contract for the created subscription.

Example:
{ "period": "years", "count": 1 }
​
renew_automatically
boolean
required

Indicates if the subscription to the plan should automatically renew.

Example:

true

​
renew_for
object
required

Interval to renew thr subscription for if renew_automatically is enabled.

Example:
{ "period": "years", "count": 1 }
​
products
object[]
required
​
custom_properties
object
required

A list of key value with the slug of the custom property as the key and the custom property value as value.