Update customer

put https://api.conekta.io/customers/{id}

You can update customer-related data

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

string

required

Identifier of the resource

Body Params

requested field for customer

antifraud_info

object | null

date_of_birth

string

It is a parameter that allows to identify the date of birth of the client.

default_payment_source_id

string

It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id)

string

An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc).

name

string

Client's name

phone

string

Is the customer's phone number

plan_id

string

Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription

default_shipping_contact_id

string

It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact)

corporate

boolean

Defaults to false

It is a value that allows identifying if the email is corporate or not.

custom_reference

string

It is an undefined value.

fiscal_entities

array of objects

fiscal_entities

metadata

object

national_id

string

It is a parameter that allows to identify the national identification number of the client.

payment_sources

array

Contains details of the payment methods that the customer has active or has used in Conekta

payment_sources

shipping_contacts

array of objects

Contains the detail of the shipping addresses that the client has active or has used in Conekta

shipping_contacts

subscription

object

It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed

Headers

Accept-Language

string

Defaults to es

Use for knowing which language to use

X-Child-Company-Id

string

In the case of a holding company, the company id of the child company to which will process the request.

Responses

Response body

object

antifraud_info

object | null

first_paid_at

integer

account_created_at

int64

corporate

boolean

true if the customer is a company

created_at

int64

required

Creation date of the object

custom_reference

string

Custom reference

date_of_birth

string

It is a parameter that allows to identify the date of birth of the client.

default_fiscal_entity_id

string | null

default_shipping_contact_id

string

default_payment_source_id

string | null

string

fiscal_entities

object

pagination metadata

has_more

boolean

required

Indicates if there are more pages to be requested

object

string

required

Object type, in this case is list

data

array of objects

data

object

address

object

required

tax_id

string

phone

string

metadata

object

company_name

string

required

object

string

required

created_at

int64

required

parent_id

string

default

boolean

string

required

Customer's ID

livemode

boolean

required

true if the object exists in live mode or the value false if the object exists in test mode

name

string

required

Customer's name

national_id

string

It is a parameter that allows to identify the national identification number of the client.

metadata

object

Has additional fields

object

string

required

payment_sources

object

page metadata

has_more

boolean

required

Indicates if there are more pages to be requested

object

string

required

Object type, in this case is list

next_page_url

string | null

URL of the next page.

previous_page_url

string | null

Url of the previous page.

data

array

customer_payment_methods_data

phone

string

Customer's phone number

shipping_contacts

object

pagination metadata

has_more

boolean

required

Indicates if there are more pages to be requested

object

string

required

Object type, in this case is list

data

array of objects

data

object

phone

string

Phone contact

receiver

string

Name of the person who will receive the order

between_streets

string

The street names between which the order will be delivered.

address

object

required

Address of the person who will receive the order

parent_id

string

default

boolean | null

deleted

boolean | null

metadata

object

Metadata associated with the shipping contact

Has additional fields

string

required

object

string

required

created_at

int64

required

subscription

object

subscription model

billing_cycle_start

int64 | null

billing_cycle_end

int64 | null

canceled_at

int64 | null

canceled_reason

string

Reason for cancellation. This field appears when the subscription status is 'canceled'.

card_id

string

charge_id

string | null

created_at

int64

customer_custom_reference

string

customer_id

string

last_billing_cycle_order_id

string

object

string

paused_at

int64 | null

plan_id

string

status

string

subscription_start

integer

trial_start

int64 | null

trial_end

int64 | null

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.conekta.io/customers/id \
3
     --header 'Accept-Language: es' \
4
     --header 'accept: application/vnd.conekta-v2.1.0+json' \
5
     --header 'content-type: application/json' \
6
     --data '{"corporate":false}'

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.conekta-v2.1.0+json

200successful operation

401authentication error

402payment required error

422parameter validation error

500internal server error