Customers

Manage customer records and payment history

Customers represent the people who pay through your payment links. Customer records are automatically created when a wallet completes a checkout session, but you can also create and manage them manually via the API.

Info

Customer name and email fields are encrypted at rest for privacy compliance. They are decrypted automatically when retrieved via the API.

The Customer object

id string

Unique identifier for the customer (e.g., cust_abc123).

wallet_address string

The customer's wallet address.

name string | null

Customer name. Encrypted at rest.

email string | null

Customer email. Encrypted at rest.

metadata object | null

Arbitrary key-value pairs for your own use.

total_spent string

Total amount spent across all completed transactions (in USD equivalent).

transaction_count number

Total number of completed transactions.

first_seen_at string

ISO 8601 timestamp of the customer's first transaction.

last_seen_at string

ISO 8601 timestamp of the customer's most recent transaction.

created_at string

ISO 8601 creation timestamp.

updated_at string

ISO 8601 last update timestamp.

List customers

Retrieve a paginated list of customers with optional search.

search string

Search customers by wallet address, name, or email.

page number default: 1

Page number for pagination.

limit number default: 20

Number of results per page (max 100).

curl -X GET "https://platform-api.anyspend.com/api/v1/customers?search=acme&page=1&limit=20" \
  -H "Authorization: Bearer asp_xxx"

import { AnySpend } from "@b3dotfun/sdk";

const anyspend = new AnySpend(process.env.ANYSPEND_API_KEY!);

const { data, pagination } = await anyspend.customers.list({
  search: "acme",
  page: 1,
  limit: 20,
});

json
{
  "data": [
    {
      "id": "cust_abc123",
      "wallet_address": "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
      "name": "Alice Johnson",
      "email": "alice@acme.com",
      "metadata": {
        "company": "Acme Inc.",
        "plan": "pro"
      },
      "total_spent": "250.00",
      "transaction_count": 5,
      "first_seen_at": "2026-01-15T10:30:00Z",
      "last_seen_at": "2026-02-25T14:22:00Z",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-25T14:22:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}

Create a customer

Manually create a customer record. This is useful for pre-registering customers before they make a payment.

wallet_address string required

The customer's wallet address.

name string

Customer name. Will be encrypted at rest.

email string

Customer email. Will be encrypted at rest.

metadata object

Arbitrary key-value pairs (e.g., {"plan": "pro"}). Up to 50 keys, 500 character values.

Warning

If a customer with the same wallet_address already exists, the request will return a 409 Conflict error. Use the update endpoint to modify existing customers.

curl -X POST "https://platform-api.anyspend.com/api/v1/customers" \
  -H "Authorization: Bearer asp_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_address": "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
    "name": "Alice Johnson",
    "email": "alice@acme.com",
    "metadata": {
      "company": "Acme Inc.",
      "plan": "pro"
    }
  }'

const customer = await anyspend.customers.create({
  walletAddress: "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
  name: "Alice Johnson",
  email: "alice@acme.com",
  metadata: {
    company: "Acme Inc.",
    plan: "pro",
  },
});

json
{
  "id": "cust_abc123",
  "wallet_address": "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
  "name": "Alice Johnson",
  "email": "alice@acme.com",
  "metadata": {
    "company": "Acme Inc.",
    "plan": "pro"
  },
  "total_spent": "0.00",
  "transaction_count": 0,
  "first_seen_at": null,
  "last_seen_at": null,
  "created_at": "2026-02-27T10:00:00Z",
  "updated_at": "2026-02-27T10:00:00Z"
}

Retrieve a customer

id string required

The customer ID (e.g., cust_abc123).

curl -X GET "https://platform-api.anyspend.com/api/v1/customers/cust_abc123" \
  -H "Authorization: Bearer asp_xxx"

const customer = await anyspend.customers.retrieve("cust_abc123");

Returns the full Customer object.

Update a customer

Update an existing customer. Only the fields you include in the request body will be updated.

id string required

The customer ID.

name string

Updated customer name.

email string

Updated customer email.

metadata object

Updated metadata. This replaces the entire metadata object. To add a single key, include the full existing metadata plus the new key.

Tip

The wallet_address cannot be changed after creation. To associate a customer with a different wallet, create a new customer record.

curl -X PATCH "https://platform-api.anyspend.com/api/v1/customers/cust_abc123" \
  -H "Authorization: Bearer asp_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alice Johnson-Smith",
    "metadata": {
      "company": "Acme Inc.",
      "plan": "enterprise",
      "upgraded_at": "2026-02-27"
    }
  }'

const updated = await anyspend.customers.update("cust_abc123", {
  name: "Alice Johnson-Smith",
  metadata: {
    company: "Acme Inc.",
    plan: "enterprise",
    upgraded_at: "2026-02-27",
  },
});

Returns the updated Customer object.

Delete a customer

Permanently delete a customer record. Transaction history associated with this customer is preserved but the customer reference will show as deleted.

id string required

The customer ID.

Warning

This action is irreversible. All personally identifiable information (name, email) will be permanently deleted.

curl -X DELETE "https://platform-api.anyspend.com/api/v1/customers/cust_abc123" \
  -H "Authorization: Bearer asp_xxx"

await anyspend.customers.delete("cust_abc123");

json
{
  "id": "cust_abc123",
  "deleted": true
}

List customer transactions

Retrieve the transaction history for a specific customer.

id string required

The customer ID.

status string

Filter by transaction status: pending, confirming, completed, failed.

page number default: 1

Page number.

limit number default: 20

Results per page (max 100).

curl -X GET "https://platform-api.anyspend.com/api/v1/customers/cust_abc123/transactions?status=completed&page=1&limit=10" \
  -H "Authorization: Bearer asp_xxx"

const { data, pagination } = await anyspend.customers.transactions("cust_abc123", {
  status: "completed",
  page: 1,
  limit: 10,
});

json
{
  "data": [
    {
      "id": "tx_tx001",
      "customer_id": "cust_abc123",
      "payment_link_id": "pl_abc123",
      "session_id": "cs_sess001",
      "status": "completed",
      "amount": "50000000",
      "amount_usd": "50.00",
      "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "chain_id": 1,
      "tx_hash": "0x9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e",
      "payer_address": "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
      "recipient_address": "0x1234567890abcdef1234567890abcdef12345678",
      "created_at": "2026-02-25T08:15:00Z",
      "completed_at": "2026-02-25T08:16:30Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 5,
    "total_pages": 1,
    "has_more": false
  }
}

Export customers

Export your customer data in CSV or JSON format. The response is streamed as a file download.

format string required

Export format. One of: csv, json.

search string

Filter exported customers by search term.

Info

Exports are limited to 10,000 records. For larger datasets, use pagination with the list endpoint.

# Download as CSV
curl -X GET "https://platform-api.anyspend.com/api/v1/customers/export?format=csv" \
  -H "Authorization: Bearer asp_xxx" \
  -o customers.csv

# Download as JSON
curl -X GET "https://platform-api.anyspend.com/api/v1/customers/export?format=json" \
  -H "Authorization: Bearer asp_xxx" \
  -o customers.json

// Get export as a ReadableStream
const csvStream = await anyspend.customers.export({ format: "csv" });

// Or get as JSON array
const customers = await anyspend.customers.export({ format: "json" });

csv
id,wallet_address,name,email,total_spent,transaction_count,first_seen_at,last_seen_at,created_at
cust_abc123,0xaabb...5678,Alice Johnson,alice@acme.com,250.00,5,2026-01-15T10:30:00Z,2026-02-25T14:22:00Z,2026-01-15T10:30:00Z
cust_def456,0xccdd...9012,Bob Smith,bob@example.com,100.00,2,2026-02-01T09:00:00Z,2026-02-20T16:45:00Z,2026-02-01T09:00:00Z

json
{
  "data": [
    {
      "id": "cust_abc123",
      "wallet_address": "0xaabb1234ccdd5678eeff9900aabb1234ccdd5678",
      "name": "Alice Johnson",
      "email": "alice@acme.com",
      "total_spent": "250.00",
      "transaction_count": 5,
      "first_seen_at": "2026-01-15T10:30:00Z",
      "last_seen_at": "2026-02-25T14:22:00Z",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 2
}

Was this page helpful?

Previous Products

Next Transactions