API ReferenceFacilities

Create a limit reduction notice

Create a limit reduction notice, which should be presented to the user when their credit limit is reduced. This endpoint must be called before reducing the credit limit. The document_id returned should be stored and used in the PATCH /facilities/{facility_id}/update_limit endpoint.

Path parameters

facility_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
new_limit_amountintegerRequired

Amount of the new credit limit, in cents

reasonslist of enumsRequired

The reasons for the limit reduction

Response

This endpoint returns an object.
document_urlstring

The URL where the document can be accessed.

idstring

The unique identifier for the document.

Errors