APICenter
DocsBuildLearn
Guides & Tutorials

Customers

Create and look up customer records owned by a consumer service.

Customer records are scoped to the registered consumer service and its owning tribe. They can be referenced by supported billing resources.

For a Node.js backend, use api.payments.customers.create(...) from the APICenter SDK. The REST example below is for other runtimes.

Create a customer

  • Endpoint: POST /api/v1/payments/customers
  • Required scope: payments:customers:write or a broader payment write scope
  • Required header: Idempotency-Key
curl -X POST https://api.apicenter.itsandbox.site/api/v1/payments/customers \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Idempotency-Key: cust-idem-991" \
  -H "Content-Type: application/json" \
  -d '{
    "customerReference": "USER-SUB-1029",
    "email": "juan.delacruz@example.com",
    "name": "Juan Dela Cruz"
  }'

Use the returned customerId when creating a supported subscription. The customer API stores customer records; reusable payment-method setup is not currently exposed by the public API.

Look up a customer

Use GET /api/v1/payments/customers/{customerId} with the payments:customers:read scope or a broader payment read scope.