Update commitment

PUT

/v1/commitments/{commitment_id}

Update a commitment.

Parameters

Path Parameters

commitment_id

required

Commitment Id

string format: uuid

Request Body ^required

CommitmentUpdate

object

commitment_type

Any of:

string

string

<= 50 characters

null

null

amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

invoice_display_name

Any of:

string

string

<= 255 characters

null

null

Responses

200

Successful Response

CommitmentResponse

object

id

required

Id

string format: uuid

plan_id

required

Plan Id

string format: uuid

commitment_type

required

Commitment Type

string

amount_cents

required

Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

invoice_display_name

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Commitment not found

422

Validation error