Companies
Create company
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
Companies
Create company
Create a new company to which the authentication token will have access to.
POST
/
v1
/
companies
curl --request POST \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Acme",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}'{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"favicon_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Company name.
Address of the default invoicing entity
Address name.
Address first line.
Address second line (optional).
Address city.
Address ZIP code.
Address state (only for US country).
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 Response
201 - application/json
Company ID.
Company name.
Logo URL of the default invoicing entity.
Favicon URL of the default invoicing entity.
Address of the default invoicing entity
Address name.
Address first line.
Address second line (optional).
Address city.
Address ZIP code.
Address state (only for US country).
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 Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Acme",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}'{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"favicon_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}