Update a business for a customer
Changed onUpdates a business for a customer using its ID and related customer ID.
If successful, your response includes a copy of the updated business entity.
Request
- Base URLhttps://sandbox-api.paddle.com
- AuthHTTP bearer
Path parameters
Paddle ID of the business entity to work with.
Unique Paddle ID for this customer entity, prefixed with ctm_.
Paddle ID of the customer entity to work with.
Request body
Example request
{
"company_number": "123456789",
"tax_identifier": "AB0123456789",
"contacts": [
{
"email": "test@paddle.com"
}
],
"custom_data": {
"customer_reference_id": "abcd1234"
}
}Response
The request has succeeded.
Example response
{
"data": {
"id": "biz_01grrebrzaee2qj2fqqhmcyzaj",
"customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
"company_number": "123456789",
"tax_identifier": "AB0123456789",
"contacts": [
{
"email": "test@paddle.com"
}
],
"created_at": "2024-10-12T07:20:50.52Z",
"updated_at": "2024-10-13T07:20:50.52Z",
"custom_data": {
"customer_reference_id": "abcd1234"
},
"import_meta": {
"external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
"imported_from": "paddle_classic"
}
},
"meta": {
"request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
}
}Changes
- breaking
added the pattern
^ctm_[a-z\d]{26}$to thepathrequest parametercustomer_id
- breaking
- breaking
added the new path request parameter
business_id - breaking
added the new path request parameter
customer_id - breaking
request body became required
- breaking
added to the
request propertyallOflist - breaking
the request property
became not nullable - breaking
the request property
became not nullable - breaking
the request property
became not nullable - breaking
removed
subschema #2from therequest propertyoneOflist - breaking
the
request property type changed fromstringto no type - breaking
response property
data/company_numberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
data/tax_identifierlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
the
///response property's maxLength was unset from320for the response status - breaking
the
///response property's maxLength was unset from1024for the response status - breaking
the
/response property's maxLength was unset from1024for the response status - breaking
the
///response property's minLength was decreased from1to0for the response status - breaking
the
///response's property type changed fromstringto no type, and format fromemailto no format for status - breaking
the
///response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
response's property type changed fromobjectto no type for status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
added
subschema #2to therequest propertyanyOflist - info
request property
list-of-types was widened by adding typesnullto media typeapplication/json - info
request property
list-of-types was widened by adding typesnullto media typeapplication/json - info
request property
list-of-types was widened by adding typesnullto media typeapplication/json - info
the response optional property
/became not read-only for the status - info
added to the
response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
///response propertyallOflist for the response status - info
added to the
///response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added
subschema #2to the/response propertyanyOflist for the response status - info
added
subschema #2to the/response propertyanyOflist for the response status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
removed the
activeenum value from the/response property for the response status - info
removed the
archivedenum value from the/response property for the response status - info
removed
subschema #2from the/response propertyoneOflist for the response status - info
removed
subschema #2from the/response propertyoneOflist for the response status - info
the
/response's property pattern^ctm_[a-z\d]{26}$was removed for the status - info
the
/response's property pattern^biz_[a-z\d]{26}$was removed for the status
- breaking