Update a customer by ID or external identifier
curl --request PATCH \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"address": null,
"child_rollup_billing": null,
"child_rollup_billing_config": {
"auto_charges": null,
"end_date": null,
"frequency": null,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": null,
"start_date": null
},
"email": null,
"exclude_from_metrics": null,
"identifier": null,
"locale": null,
"metadata": {},
"name": null,
"org_name": null,
"override_taxes": null,
"owner_id": null,
"parent_customer_id": null,
"phone": null,
"status": null,
"title": null
}'
{
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "<string>",
"place_id": null,
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"inherited_from_id": null,
"inherited_from_type": null,
"key": "<string>",
"name": "<string>",
"original_value": "<any>",
"overridden": null,
"type": "<string>",
"value": "<any>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": null,
"parent_customer_id": null,
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The idempotency key that will be used to ensure the request is only performed once
The company ID with the prefix 'cmp_'.
customer_id or identifier
OK
The response is of type object
.
curl --request PATCH \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"address": null,
"child_rollup_billing": null,
"child_rollup_billing_config": {
"auto_charges": null,
"end_date": null,
"frequency": null,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": null,
"start_date": null
},
"email": null,
"exclude_from_metrics": null,
"identifier": null,
"locale": null,
"metadata": {},
"name": null,
"org_name": null,
"override_taxes": null,
"owner_id": null,
"parent_customer_id": null,
"phone": null,
"status": null,
"title": null
}'
{
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "<string>",
"place_id": null,
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"inherited_from_id": null,
"inherited_from_type": null,
"key": "<string>",
"name": "<string>",
"original_value": "<any>",
"overridden": null,
"type": "<string>",
"value": "<any>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": null,
"parent_customer_id": null,
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}