Customers API

Customers are keyed by your identifier. Create one before charging, or let the first payment create it implicitly through customerOrder.customer.

POST /api/apps/{appId}/customers 201 Created

Create a customer

Parameter Type Required Description
customerId string Yes Your identifier for the customer. Must be unique within the app.
firstName, lastName string No Buyer name.
email string No Used for receipts and provider-side risk checks.
mobileNumber string No Contact number.
fraudPolicyId integer No Pin this customer to a specific fraud policy.
cURL
curl -X POST https://api.paymenthood.com/api/apps/YOUR_APP_ID/customers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cus-42",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": "[email protected]",
    "mobileNumber": "+441234567890"
  }'
GET /api/apps/{appId}/customers/{customerId} 200 OK

Retrieve a customer

JSON
{
  "customerId": "cus-42",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "email": "[email protected]",
  "mobileNumber": "+441234567890",
  "app": {
    "appId": "YOUR_APP_ID",
    "friendlyName": "Acme Store",
    "isSandbox": true,
    "isBlocked": false,
    "createdTime": "2026-01-04T10:00:00Z"
  }
}
Method Path Purpose
GET /customers List customers for the app.
PATCH /customers/{customerId} Update name, email or phone.
GET /customers/{customerId}/payment-methods List stored payment methods available for auto payments.
DELETE /customers/{customerId}/payment-methods/{paymentMethodId} Remove a stored method.
DELETE /customers/{customerId}/auto-payments/{customerAutomaticProfileId} Stop an auto-payment registration — use this when a subscription is cancelled.
GET /customers/{customerId}/panel-link Generate a signed link to the customer's own panel, where they manage their payment methods.