Get products

curl --request GET \
  --url https://api.hyperline.co/v1/products \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0,
    "approximateCount": false
  },
  "data": [
    {
      "id": "itm_3kXODDF42QXtnL",
      "name": "Product name",
      "status": "active",
      "description": "Product internal description",
      "description_display_interval_dates": true,
      "public_description": "Product public description",
      "translations": {},
      "properties": null,
      "custom_properties": {},
      "accounting": {},
      "type": "flat_fee",
      "is_available_on_demand": true,
      "is_available_on_subscription": true
    }
  ]
}

GET

products

Get products

curl --request GET \
  --url https://api.hyperline.co/v1/products \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0,
    "approximateCount": false
  },
  "data": [
    {
      "id": "itm_3kXODDF42QXtnL",
      "name": "Product name",
      "status": "active",
      "description": "Product internal description",
      "description_display_interval_dates": true,
      "public_description": "Product public description",
      "translations": {},
      "properties": null,
      "custom_properties": {},
      "accounting": {},
      "type": "flat_fee",
      "is_available_on_demand": true,
      "is_available_on_subscription": true
    }
  ]
}

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

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

status

Available options:

all,

active,

archived

status__in

Available options:

all,

active,

archived

name

string

name__not

string

name__isNull

string

name__isNotNull

string

name__equals

string

name__contains

string

name__startsWith

string

name__endWith

string

description

string

description__not

string

description__isNull

string

description__isNotNull

string

description__equals

string

description__contains

string

description__startsWith

string

description__endWith

string

type

string

type__not

string

type__isNull

string

type__isNotNull

string

type__equals

string

type__contains

string

type__startsWith

string

type__endWith

string

price_book_id

string

Response

200 - application/json

meta

object

required

Show child attributes

meta.total

number

required

Total of existing items.

Example:

1

meta.taken

number

required

Number of items returned.

Example:

1

meta.skipped

number

required

Number of items skipped.

Example:

0

meta.approximateCount

boolean

Whether the total count is approximate.

Example:

false

data

(Fee product · object | Seat product · object | Dynamic product · object | Credit product · object)[]

required

List of Product.

Fee product
Seat product
Dynamic product
Credit product

Show child attributes

data.id

string

required

Product ID.

Example:

"itm_3kXODDF42QXtnL"

data.name

string

required

Product name.

Example:

"Product name"

data.status

enum<string>

required

Product status.

active: The product is active and can be used in new quotes/subscriptions/invoices.
archived: The product is archived and can't be used anymore.

Available options:

active,

archived

Example:

"active"

data.description

string | null

required

Product description.

Example:

"Product internal description"

data.description_display_interval_dates

boolean

required

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

data.public_description

string | null

required

Public description of the product.

Example:

"Product public description"

data.translations

object

required

Product name and description translations.

Show child attributes

data.translations.{key}

object

Show child attributes

data.translations.{key}.name

string | null

data.translations.{key}.public_description

string | null

data.properties

object

required

Key/value pairs to store any metadata useful in your context.

Show child attributes

data.properties.{key}

Example:

null

data.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.

Show child attributes

data.custom_properties.{key}

data.accounting

object

required

Mapping invoicing entity ID/accounting settings.

Show child attributes

data.accounting.{key}

object

Show child attributes

data.accounting.{key}.tax_rate_id

string | null

required

Custom tax rate ID.

Example:

"taxr_YfiSnLIYORD9VN"

data.accounting.{key}.product_code

string | null

required

Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.

Example:

"PROD-23"

data.accounting.{key}.account_code

string | null

required

Code used to assign related invoices line items to a General Ledger account in your external accounting tool.

Example:

"GL-001"

data.type

enum<string>

required

Product type.

Available options:

flat_fee

data.is_available_on_demand

boolean

required

deprecated

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

Example:

true

data.is_available_on_subscription

boolean

required

deprecated

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

Example:

true

Delete price configuration Get product

⌘I

API documentation

Integrations

Analytics

Bank Accounts

Billable events

Companies

Coupons

Coupons > Promotion codes

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Exports

Files

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Subscriptions > Templates

Taxes

Third-party apps

Wallets

Webhooks

Get products

Authorizations

Query Parameters

Response