customers

End customer-unit cap (by external customer id)

Ends the cap on this customer unit for one credits currency by setting effectiveUntil to now on every open version — the one in force, older overlapping versions still open, and versions scheduled to start later — so nothing can resurface or activate afterwards; nothing is deleted and history is kept. Select the currency with creditsCurrencyId; it may be omitted only when the organization has exactly one credits currency. 404 when the customer or the unit does not exist, or there is no open version for that currency. Addresses the customer by your external customer id.

delete/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 whose cap to end. 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 cap limits. The cap's amount is in this currency's credits.

endedVersionsinteger required

How many versions were closed by this call: the one in force, older overlapping versions still open, and scheduled versions. At least 1.

Changes

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