Create commitment

POST

/v1/plans/{plan_code}/commitments

Add a commitment to a plan.

Parameters

Path Parameters

plan_code

required

Plan Code

string

Request Body ^required

CommitmentCreateAPI

object

commitment_type

Commitment Type

string

default: minimum_commitment <= 50 characters

amount_cents

required

Any of:

number

number

string

string

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

invoice_display_name

Any of:

string

string

<= 255 characters

null

null

Responses

201

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

Plan not found

422

Validation error