Sign in
Customers

Create a customer

Create a new customer record. Customers can be associated with payments for tracking and recurring billing.

post/v1/customers

Headers

X-Idempotency-Keystring required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.

Request body

externalIdstring

Your own customer ID.

namestring
emailstring email
documentstring

CPF or CNPJ number.

documentType'CPF' | 'CNPJ'
phonestring
metadataobject

Response

Customer created.

Changes

Changed in 3 of the 13 revisions of this API.145

  • 9d4ba1cc037c133See the full diff
    • ▲

      the error response's property type/format changed from object/ to string/ for status 409

      response-property-type-changed

    • ●

      removed the optional property error/code from the response with the 409 status

      response-optional-property-removed

    • ●

      removed the optional property error/details from the response with the 409 status

      response-optional-property-removed

    • ●

      removed the optional property error/message from the response with the 409 status

      response-optional-property-removed

    • ○

      added the optional property code to the response with the 409 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 409 status

      response-optional-property-added

    • ○

      added the optional property statusCode to the response with the 409 status

      response-optional-property-added

  • a382df24e84311See the full diff
    • ●

      removed the optional property customer/id from the response with the 201 status

      response-optional-property-removed

    • ○

      added the optional property customer/customerId to the response with the 201 status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c756571007571See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog