Buyer object

A buyer is a customer who buys or subscribes to your products. When subscribing to any of your products, the buyer's email and name will be asked. And in case the product has extra fields, they will also be requested when subscribing to the product.

{
    "buyer": {
        "name": "Jhon Smith",
        "email": "[email protected]",
        "external_id": "customer001",
        "shipping_address": {
						"id": "b9fa18f2-87e9-4bf2-b97c-acea1811fc7e"
            "address1": "calle ejemplo",
            "region": "Tarapacá",
            "comune": "Camiña"
				}
    }
}

Attributes

The attributes available to a Buyer object are:

Name	Type	Description	Required
id	string	Buyer unique identifier.	false
name	string	Name of the Buyer you want to create.	false
email	string	The customer's email to which will be notified for payments.	true
external_id	string	An external id to identify the Buyer.	false

Shipping address

Each buyer can carry a shipping address — the physical destination used for services that ship a product (e.g. single payments or subscriptions with ask_shipping_address enabled).

Unique per buyer

A buyer has at most one shipping address (Buyer has_one :shipping_address). There is no collection of addresses — reading or updating the shipping address always targets that single record. Sending new address data overwrites the existing one rather than adding another.

Read-only over the API (for now)

The shipping address is currently exposed for reading only through the integration API and webhooks — it cannot be created or updated via the integration API yet. It is captured through the checkout flow and surfaced back to integrators as output.

It appears nested under the buyer.
In webhooks it is included only in accepted_transaction and in rejected_transaction.
Any shipping_address payload sent to integration endpoints is ignored — it is not a writable field.

Fields returned

Field	Type	Notes
`id`	uuid	Identifier of the address record.
`region`	string	Chilean region.
`commune`	string	Chilean commune.
`address1`	string	Street address, line 1.