Get product

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

{
  "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,
  "price_configurations": [
    {
      "id": "<string>",
      "price_book_id": "<string>",
      "status": "active",
      "currency": "EUR",
      "country": "FR",
      "plan_id": "<string>",
      "billing_interval": {
        "period": "once"
      },
      "commitment_interval": {
        "period": "all"
      },
      "updated_at": "2023-12-25",
      "archived_at": "2023-12-25",
      "type": "fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123,
          "id": "<string>"
        }
      ]
    }
  ]
}

GET

products

{id}

Get product

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

{
  "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,
  "price_configurations": [
    {
      "id": "<string>",
      "price_book_id": "<string>",
      "status": "active",
      "currency": "EUR",
      "country": "FR",
      "plan_id": "<string>",
      "billing_interval": {
        "period": "once"
      },
      "commitment_interval": {
        "period": "all"
      },
      "updated_at": "2023-12-25",
      "archived_at": "2023-12-25",
      "type": "fee",
      "prices": [
        {
          "type": "fee",
          "amount": 123,
          "id": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Query Parameters

price_book_id

string

Response

200 - application/json

Fee product
Seat product
Dynamic product
Credit product

string

required

Product ID.

Example:

"itm_3kXODDF42QXtnL"

name

string

required

Product name.

Example:

"Product name"

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"

description

string | null

required

Product description.

Example:

"Product internal description"

description_display_interval_dates

boolean

required

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

public_description

string | null

required

Public description of the product.

Example:

"Product public description"

translations

object

required

Product name and description translations.

Show child attributes

translations.{key}

object

Show child attributes

translations.{key}.name

string | null

translations.{key}.public_description

string | null

properties

object

required

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

Show child attributes

properties.{key}

Example:

null

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

custom_properties.{key}

accounting

object

required

Mapping invoicing entity ID/accounting settings.

Show child attributes

accounting.{key}

object

Show child attributes

accounting.{key}.tax_rate_id

string | null

required

Custom tax rate ID.

Example:

"taxr_YfiSnLIYORD9VN"

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"

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"

type

enum<string>

required

Product type.

Available options:

flat_fee

is_available_on_demand

boolean

required

deprecated

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

Example:

true

is_available_on_subscription

boolean

required

deprecated

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

Example:

true

price_configurations

object[]

required

Show child attributes

price_configurations.id

string

required

Price configuration ID.

price_configurations.price_book_id

string | null

required

ID of the price book to which this price configuration belongs to. If null, the price configuration belongs to the default price book.

price_configurations.status

enum<string>

required

Price configuration status.

Available options:

active,

archived

Example:

"active"

price_configurations.currency

enum<string> | null

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

price_configurations.country

enum<string> | null

required

Two-letter country code in ISO format. See ISO 3166-1 alpha-2.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PT-20,

PT-30,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"FR"

price_configurations.plan_id

string | null

required

deprecated

ID of the plan on which this price configuration is eligible

price_configurations.billing_interval

object

required

Billing interval on which the price configuration is eligible.

Option 1
Option 2

Show child attributes

price_configurations.billing_interval.period

enum<string>

required

Available options:

once

price_configurations.commitment_interval

object

required

Commitment interval on which the price configuration is eligible.

Option 1
Option 2

Show child attributes

price_configurations.commitment_interval.period

enum<string>

required

Available options:

all

price_configurations.updated_at

string<date>

required

Last edition date of the price configuration.

price_configurations.archived_at

string<date> | null

required

Date of the price configuration archival.

price_configurations.type

enum<string>

required

Available options:

fee

price_configurations.prices

object[]

required

Price tiers of the price configuration. If fixed amount, only one price is available.

Maximum array length: 1

Show child attributes

price_configurations.prices.type

enum<string>

required

Available options:

fee

price_configurations.prices.amount

number

required

Monetary amount. Expressed in currency's smallest unit.

price_configurations.prices.id

string

Price ID.

Get products Create 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 product

Authorizations

Path Parameters

Query Parameters

Response