customers

Get customer state by external ID

Primary integration endpoint for agents and programmatic clients using their own customer IDs. Use the value you stored on customer.externalId, for example customer_123.

get/customers/external/{externalId}/state

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/external/{externalId}/state
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Customer ID from the integrator's system, stored on Paid as externalId.

Response

200

defaultCurrencystring required

ISO 4217 currency code, for example USD, EUR, or GBP.

timestampstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.