customers

Get customer by external ID

Get a customer by external ID

get/customers/external/{externalId}

Request

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

Path parameters

externalIdstring required

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

Response

200

idstring required

Stable Paid customer display ID. Use this value as the {id} path parameter for customer routes, for example GET /api/v2/customers/cus_abc123/state.

namestring required
legalNamestring nullable required
emailstring required
phonestring required
websitestring required
externalIdstring nullable required
creationState'draft' | 'active' required
status'active' | 'churned' required

Customer status: churned when the customer is marked as churned, active otherwise.

churnDatestring date-time nullable required
vatNumberstring nullable required
metadataobject nullable required
defaultCurrencystring required

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

createdAtstring date-time required
updatedAtstring date-time required

Changes

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