Skip to navigation
Billing Credits

Acquire credit lease

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
company_idstringRequired
credit_type_idstringRequired
requested_amountdoubleRequired<=9999999999
expires_atdatetime or nullOptional

When the hold lapses if the lease is never released; defaults to five minutes from now and may be at most one hour out. The unspent hold is refunded on expiry

Response

Created
dataobject
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error