customers

Get customer-unit cap (by external customer id)

Returns the cap in force on this customer unit for one credits currency, with usage in the current period when available. Select the currency with creditsCurrencyId; it may be omitted only when the organization has exactly one credits currency, which is then used and echoed back. 404 when the customer or the unit does not exist, or the unit has no cap in force for that currency. The usage figures are advisory: other spend may land between this read and the next burn. Addresses the customer by your external customer id.

get/customers/external/{externalId}/customer-units/{externalCustomerUnitId}/cap

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/external/{externalId}/customer-units/{externalCustomerUnitId}/cap
  • Auth: HTTP bearer

Path parameters

externalIdstring required

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

externalCustomerUnitIdstring required

Your own id for the unit (its externalId), unique within this customer.

Query parameters

creditsCurrencyIdstring uuid

The credits currency to read. Omit it only when the organization has exactly one credits currency, which is then used; otherwise it is required.

Response

200

externalCustomerUnitIdstring required

Your own id for the unit (its externalId), the identifier the unit and cap routes take.

customerIdstring required

The Paid display id of the customer the unit belongs to.

creditsCurrencyIdstring uuid required

The credits currency this response is about: the requested creditsCurrencyId, or the organization's only credits currency when it was omitted.

Changes

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