Skip to main content
POST
Create a commitment

Authorizations

Authorization
string
header
required

Pass your API key as a bearer token. Test keys start with sk_test_; Live keys start with sk_live_.

Path Parameters

id
string
required

The account ID.

quoteId
string
required

The quote ID.

Body

application/json
hold_hours
number

Optional hold duration in hours.

deposit_amount_cents
integer

Optional deposit amount in cents.

external_ref
string

Optional external reference for the commitment.

Response

The commitment (already existed).

object
enum<string>
Available options:
commitment
commitment_id
string
created
boolean

Whether a new commitment was created (false if it already existed).

state
string

The commitment's state.