Update a customer
POST {{baseUrl}}/v1/customers/:customer
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due
state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
This request accepts mostly the same arguments as the customer creation call.
Request Body
[{"name"=>"address[city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"balance", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"bank_account[account_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[account_holder_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[account_holder_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[object]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"bank_account[routing_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[exp_month]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"card[exp_year]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"card[number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[address_zip]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[cvc]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"card[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"card[object]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"cash_balance[settings][reconciliation_mode]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"coupon", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_alipay_account", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_bank_account", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_card", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_source", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"email", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_prefix", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][0][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][1][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[default_payment_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[footer]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[rendering_options][amount_tax_display]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"name", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"next_invoice_sequence", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phone", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"preferred_locales[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"preferred_locales[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"promotion_code", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"source", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax[ip_address]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax[validate_location]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_exempt", "value"=>"<string>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |