API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
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
Customers
Update customer
Update the details of an existing customer.
PUT
/
v1
/
customers
/
{id}
curl --request PUT \
--url https://api.hyperline.co/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"billing_address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
},
"billing_email": "billing@acme.com",
"invoice_emails": [
"accounting@acme.com"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"payment_method_id": "pm_UTclbc1US8GzCe",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
}'
{
"id": "cus_Typ0px2W0aiEtl",
"name": "Acme",
"type": "corporate",
"status": "active",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_number_valid": true,
"vat_rate_custom": 123,
"language": "fr",
"timezone": "Europe/Paris",
"external_id": "<string>",
"properties": {},
"custom_properties": {},
"billing_address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
},
"billing_email": "billing@acme.com",
"invoice_emails": [
"accounting@acme.com"
],
"invoicing_entity_id": "ive_484dn4U48E",
"invoice_reminders_enabled": true,
"price_book_id": "prib_613_WbVIZ1329e",
"available_payment_methods": [
"card",
"direct_debit"
],
"current_payment_method_type": "card",
"current_payment_method_id": "pm_UTclbc1US8GzCe",
"custom_payment_delay": 30,
"subscriptions": [
{
"id": "sub_0kIc7jrF7gV00V",
"status": "active",
"current_period_started_at": "2024-10-12T07:00:01.860Z",
"current_period_ends_at": "2024-11-12T07:00:01.860Z",
"plan_id": "plan_34hdd843hReh",
"checkout_session_id": "che_949djdj39RJj"
}
],
"created_at": "2024-10-12T07:00:01.860Z",
"updated_at": "2024-10-12T07:00:01.860Z",
"deleted_at": "2024-10-13T02:00:00.000Z",
"providers": {
"stripe": "cus_Ol3QIaTstxxxxx"
},
"current_payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2026-11",
"brand": "visa"
},
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"organisation_id": "<string>",
"organisation_invoicing": "none"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200
application/json
The response is of type object
.
Was this page helpful?
curl --request PUT \
--url https://api.hyperline.co/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"billing_address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
},
"billing_email": "billing@acme.com",
"invoice_emails": [
"accounting@acme.com"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"payment_method_id": "pm_UTclbc1US8GzCe",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
}'
{
"id": "cus_Typ0px2W0aiEtl",
"name": "Acme",
"type": "corporate",
"status": "active",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_number_valid": true,
"vat_rate_custom": 123,
"language": "fr",
"timezone": "Europe/Paris",
"external_id": "<string>",
"properties": {},
"custom_properties": {},
"billing_address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
},
"billing_email": "billing@acme.com",
"invoice_emails": [
"accounting@acme.com"
],
"invoicing_entity_id": "ive_484dn4U48E",
"invoice_reminders_enabled": true,
"price_book_id": "prib_613_WbVIZ1329e",
"available_payment_methods": [
"card",
"direct_debit"
],
"current_payment_method_type": "card",
"current_payment_method_id": "pm_UTclbc1US8GzCe",
"custom_payment_delay": 30,
"subscriptions": [
{
"id": "sub_0kIc7jrF7gV00V",
"status": "active",
"current_period_started_at": "2024-10-12T07:00:01.860Z",
"current_period_ends_at": "2024-11-12T07:00:01.860Z",
"plan_id": "plan_34hdd843hReh",
"checkout_session_id": "che_949djdj39RJj"
}
],
"created_at": "2024-10-12T07:00:01.860Z",
"updated_at": "2024-10-12T07:00:01.860Z",
"deleted_at": "2024-10-13T02:00:00.000Z",
"providers": {
"stripe": "cus_Ol3QIaTstxxxxx"
},
"current_payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2026-11",
"brand": "visa"
},
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"organisation_id": "<string>",
"organisation_invoicing": "none"
}
Assistant
Responses are generated using AI and may contain mistakes.