Skip to main content
GET
/
api
/
v1
/
contract
/
{contract_id}
Contract Detail Api
curl --request GET \
  --url https://api.justpaid.io/api/v1/contract/{contract_id} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Enterprise Agreement",
  "contract_status": "accepted",
  "contract_start_date": "2024-01-01",
  "contract_end_date": "2025-01-01",
  "contract_amount": 120000,
  "currency": "USD",
  "payment_terms": "net_30",
  "is_evergreen": false,
  "customer": {
    "uuid": "customer-uuid",
    "name": "Acme Corp",
    "email": "contact@acme.com"
  },
  "plan": {
    "uuid": "plan-uuid",
    "name": "Enterprise Plan",
    "billing_cycle": "monthly",
    "payment_terms": "net_30"
  },
  "plan_items": [
    {
      "uuid": "item-uuid",
      "name": "API Calls",
      "billing_alias": "api_calls",
      "prices": [
        {
          "uuid": "price-uuid",
          "price": 0.001,
          "price_type": "usage_based_fee",
          "billing_cycle": "monthly"
        }
      ]
    }
  ],
  "line_items": [],
  "file_url": "https://api.justpaid.io/files/contract.pdf",
  "created_at": "2024-01-01T00:00:00Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

contract_id
string
required

The UUID of the contract

Response

Contract details with plan and plan items

Detailed contract information with plan and plan items.

contract_status
string
required

The current status of the contract

Example:

"accepted"

customer
object | null

Customer information Basic customer information for contract responses.

plan
object | null

Plan information if a plan is linked to this contract Basic plan information for contract responses.

plan_items
PlanItemOut · object[]

List of plan items associated with this contract's plan

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 length: 255
contract_start_date
string<date> | null
contract_end_date
string<date> | null
contract_amount
currency
string
default:USD
Maximum length: 3
payment_terms
string | null
Maximum length: 60
discounted_amount
discount_percent
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