Products
Create product
API documentation
Integrations
Analytics
Billable events
Companies
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoicing entities
Organisations
Payments
Price configurations
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Products
Create product
Create a new product.
POST
/
v1
/
products
curl --request POST \
--url https://api.hyperline.co/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"is_available_on_demand": true,
"is_available_on_subscription": true,
"custom_properties": {},
"accounting": {},
"type": "flat_fee",
"price_configurations": [
{
"currency": "EUR",
"country": "FR",
"plan_id": "<string>",
"billing_interval": {
"period": "once"
},
"commitment_interval": {
"period": "all"
},
"type": "fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
]
}'{
"id": "itm_3kXODDF42QXtnL",
"type": "flat_fee",
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"properties": {},
"custom_properties": {},
"accounting": {},
"is_available_on_demand": true,
"is_available_on_subscription": true,
"price_configurations": [
{
"id": "<string>",
"currency": "EUR",
"country": "FR",
"plan_id": "<string>",
"billing_interval": {
"period": "once"
},
"commitment_interval": {
"period": "all"
},
"updated_at": "<string>",
"type": "fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Create product payload
Product name.
Available options:
flat_fee 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 Billing interval on which the price configuration is eligible.
Available options:
once Available options:
fee Price tiers of the price configuration. If fixed amount, only one price is available.
Two-letter country code in ISO format. See ISO 3166 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, 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, 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 ID of the plan on which this price configuration is eligible
Product description.
Indicates if the dates of the interval should be automatically added in the product description on the invoices.
Public description of the product.
Product name and description translations.
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.
Mapping invoicing entity ID/accounting settings.
Custom tax rate ID.
Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.
Code used to assign related invoices line items to a General Ledger account in your external accounting tool.
Response
201 - application/json
The newly created product
Product ID.
Available options:
flat_fee Product name.
Product description.
Indicates if the dates of the interval should be automatically added in the product description on the invoices.
Public description of the product.
Product name and description translations.
Key/value pairs to store any information you find useful.
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.
Mapping invoicing entity ID/accounting settings.
Custom tax rate ID.
Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.
Code used to assign related invoices line items to a General Ledger account in your external accounting tool.
Enable the product to be billed at any time as a one-time payment.
Enable the product to be added as part of a subscription.
Price configuration ID.
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 Two-letter country code in ISO format. See ISO 3166 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, 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, 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 ID of the plan on which this price configuration is eligible
Billing interval on which the price configuration is eligible.
Available options:
once Commitment interval on which the price configuration is eligible.
Available options:
all Last edition date of the price configuration.
Available options:
fee Price tiers of the price configuration. If fixed amount, only one price is available.
Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"is_available_on_demand": true,
"is_available_on_subscription": true,
"custom_properties": {},
"accounting": {},
"type": "flat_fee",
"price_configurations": [
{
"currency": "EUR",
"country": "FR",
"plan_id": "<string>",
"billing_interval": {
"period": "once"
},
"commitment_interval": {
"period": "all"
},
"type": "fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
]
}'{
"id": "itm_3kXODDF42QXtnL",
"type": "flat_fee",
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"properties": {},
"custom_properties": {},
"accounting": {},
"is_available_on_demand": true,
"is_available_on_subscription": true,
"price_configurations": [
{
"id": "<string>",
"currency": "EUR",
"country": "FR",
"plan_id": "<string>",
"billing_interval": {
"period": "once"
},
"commitment_interval": {
"period": "all"
},
"updated_at": "<string>",
"type": "fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
]
}