GET
/
v1
/
plans
/
{id}
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
  },
  "renew_automatically": true,
  "trial_interval": {
    "period": "months",
    "count": 1
  },
  "products": [
    {
      "id": "itm_FJKlqUb8COXw55",
      "name": "Product name",
      "description": "A description of the product.",
      "description_display_interval_dates": true,
      "payment_interval": {
        "period": "months",
        "count": 1
      },
      "payment_schedule": "start",
      "type": "flat_fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123
        }
      ]
    }
  ],
  "custom_properties": {}
}

Authorizations

Authorization
string
headerrequired

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.

name
string
required

Plan name.

description
string | null
required

Plan description.

commitment_interval
object | null
required

Interval used to represent the commitment period of the plan.

renew_automatically
boolean
required

Indicates if the subscription to the plan should automatically renew.

trial_interval
object | null
required

Interval used to represent the trial period of the plan.

products
object[]
required
  • Option 1

  • Option 2

  • Option 3

custom_properties
object | null
required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.