POST
/
v1
/
products
curl --request POST \
  --url https://api.hyperline.co/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "flat_fee",
  "name": "<string>",
  "description": "<string>",
  "public_description": "<string>",
  "is_available_on_demand": true,
  "is_available_on_subscription": true,
  "is_available_at_checkout": true,
  "price_configurations": [
    {
      "name": "<string>",
      "currency": "EUR",
      "country": "<string>",
      "type": "fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123,
          "interval": "<string>"
        }
      ]
    }
  ],
  "custom_properties": {}
}'
{
  "id": "itm_3kXODDF42QXtnL",
  "name": "Product name",
  "description": "Product internal description",
  "public_description": "Product public description",
  "type": "flat_fee",
  "properties": {},
  "custom_properties": {},
  "is_available_on_subscription": true,
  "is_available_on_demand": true,
  "price_configurations": [
    {
      "id": "<string>",
      "currency": "EUR",
      "country": "FR",
      "plan_id": "<string>",
      "billing_interval": {
        "period": "weeks",
        "count": 123
      },
      "commitment_interval": {
        "period": "weeks",
        "count": 123
      },
      "updated_at": "<string>",
      "type": "fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
type
enum<string>
required

Usage of one_off is deprecated, please use flat_fee.

Available options:
flat_fee,
one_off
name
string
required
description
string | null
public_description
string | null
is_available_on_demand
boolean
default: true
is_available_on_subscription
boolean
default: true
is_available_at_checkout
boolean

Deprecated field, please use is_available_on_subscription.

price_configurations
object[]
required
custom_properties
object

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.

Response

201 - application/json
  • Option 1

  • Option 2

  • Option 3

  • Option 4

id
string
required

Product ID.

name
string
required

Product name.

description
string | null
required

Product description.

public_description
string | null
required

Public description of the product.

type
enum<string>
required
Available options:
flat_fee
properties
object | null
required

Key/value pairs to store any information you find useful.

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.

is_available_on_subscription
boolean
required

Enable the product to be added as part of a subscription.

is_available_on_demand
boolean
required

Enable the product to be billed at any time as a one-time payment.

price_configurations
object[]
required