Skip to main content
POST
Contract Create Api

Authorizations

Authorization
string
header
required

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

Body

application/json

Input schema for creating a contract manually.

customer_uuid
string<uuid>
required

UUID of the customer for this contract

Example:

"123e4567-e89b-12d3-a456-426614174000"

title
string | null

Title or name of the contract

Example:

"Enterprise Agreement 2024"

contract_start_date
string<date> | null

Contract start date

Example:

"2024-01-01"

contract_end_date
string<date> | null

Contract end date (leave null for evergreen)

Example:

"2025-01-01"

contract_amount
number | null

Total contract value

Example:

120000

currency
string | null
default:USD

ISO 4217 currency code

Example:

"USD"

payment_terms
enum<string> | null

Payment terms. Valid values: due upon receipt, net 3, net 7, net 15, net 30, net 45, net 60, net 90, net 120

Available options:
due upon receipt,
net 3,
net 7,
net 15,
net 30,
net 45,
net 60,
net 90,
net 120
Example:

"net 30"

is_evergreen
boolean | null
default:false

Whether the contract auto-renews indefinitely

Example:

false

Response

Contract created successfully

Detailed contract information with plan items.

contract_status
string
required

The current status of the contract

Example:

"accepted"

customer
CustomerBasicOut · object | null

Customer information

plan_items
PlanItemOut · object[]

List of plan items associated with this contract

file_url
string | null

URL to download the contract PDF

Example:

"https://api.justpaid.io/files/contract.pdf"

uuid
string<uuid>
title
string | null
Maximum string length: 255
contract_start_date
string<date> | null
contract_end_date
string<date> | null
contract_amount
string | null
currency
string | null
default:USD
Maximum string length: 3
payment_terms
string | null
Maximum string length: 60
discounted_amount
string | null
discount_percent
string | null
is_evergreen
boolean
default:false
invoice_start_date
string<date> | null
preferred_invoice_day
integer | null
created_at
string<date-time>
contract_summary
string | null