COconekta
Customers

Get Customer

Changed on

Gets a customer resource that corresponds to a customer ID.

get/customers/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

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

Response

successful operation

corporateboolean

true if the customer is a company

created_atinteger required

Creation date of the object

custom_referencestring

Custom reference

date_of_birthstring

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

default_fiscal_entity_idstring nullable
default_shipping_contact_idstring
default_payment_source_idstring nullable
emailstring email
idstring required

Customer's ID

livemodeboolean required

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

namestring required

Customer's name

national_idstring

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

metadataobject
objectstring required
phonestring

Customer's phone number

Example response

{
  "antifraud_info": {
    "first_paid_at": 1485151007,
    "account_created_at": 1484040996
  },
  "created_at": 1485151007,
  "custom_reference": "custom_reference",
  "date_of_birth": "24/07/1992",
  "default_fiscal_entity_id": "fis_ent_2tKqqAfqPi21oCmEJ",
  "default_shipping_contact_id": "ship_cont_2tKZsTYcsryyu7Ah8",
  "default_payment_source_id": "src_2tHJfJ79KyUwpxTio",
  "email": "Felipe@gmail.com",
  "fiscal_entities": {
    "object": "list",
    "data": [
      {
        "address": {
          "street1": "Nuevo Leon 254",
          "street2": "Departamento 404",
          "postal_code": "06100",
          "city": "Ciudad de Mexico",
          "state": "Ciudad de Mexico",
          "country": "MX"
        },
        "company_name": "conekta",
        "id": "ship_cont_2tKZsTYcsryyu7Ah8",
        "object": "shipping_contact",
        "created_at": 1675715413,
        "parent_id": "cus_2tKcHxhTz7xU5SymF"
      }
    ]
  },
  "id": "cus_2tHJfJ79KyUwpxTik",
  "livemode": true,
  "name": "Felipe",
  "national_id": "HEGG560427MVZRRL04",
  "object": "customer",
  "payment_sources": {
    "object": "list",
    "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
    "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
    "data": [
      {
        "id": "src_2s8K1B3PBKDontpi9",
        "object": "payment_source",
        "created_at": 1675715413,
        "parent_id": "cus_2s8K1B3PBKDontpi8",
        "agreements": [
          {
            "agreement": "2409526",
            "provider": "bbva_cash_in"
          }
        ],
        "reference": "93000262276908",
        "barcode": "93000262276908",
        "barcode_url": "https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png",
        "expires_at": 1742483424,
        "provider": "Cash"
      }
    ]
  },
  "phone": "+5215555555555",
  "shipping_contacts": {
    "object": "list",
    "data": [
      {
        "phone": "+525511223344",
        "receiver": "Marvin Fuller",
        "between_streets": "Ackerman Crescent",
        "address": {
          "street1": "Nuevo Leon 254",
          "street2": "Departamento 404",
          "postal_code": "06100",
          "city": "Ciudad de Mexico",
          "state": "Ciudad de Mexico",
          "country": "MX",
          "residential": true
        },
        "id": "ship_cont_2tKZsTYcsryyu7Ah8",
        "object": "shipping_contact",
        "created_at": 1675715413
      }
    ]
  },
  "subscription": {
    "billing_cycle_start": 1677626827,
    "billing_cycle_end": 1677626827,
    "canceled_at": 1678258162,
    "canceled_reason": "user_cancelation",
    "card_id": "src_2tKcHxhTz7xU5SymL",
    "charge_id": "2tKcHxhTz7xU5SymL",
    "created_at": 1677626837,
    "customer_custom_reference": "dotnet_123456",
    "customer_id": "cus_2tKcHxhTz7xU5SymF",
    "id": "gold-plan",
    "last_billing_cycle_order_id": "ord_2tSoMP7bZJbLiq4z8",
    "object": "subscription",
    "paused_at": 1678258162,
    "plan_id": "plan_2tXx672QLQ68CkmMn",
    "status": "past_due",
    "subscription_start": 1677626837,
    "trial_start": 1677626837,
    "trial_end": 1677626837
  }
}

Changes

  • 52f4c0dd8a1bRevision changes
    • breaking

      the ///// response's property type changed from no type to object for status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added subschema #1: shipping_contact_address to the ///// response property allOf list for the response status

    • info

      the ///// response's property pattern [A-Za-z]{2} was added for the status