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": "[email protected]"
  },
  "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"
}

GET

api

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": "[email protected]"
  },
  "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 items.

contract_status

string

required

The current status of the contract

Example:

"accepted"

customer

CustomerBasicOut · object

Customer information

Show child attributes

customer.external_id

string | null

External identifier for the customer

Example:

"CUST-001"

customer.uuid

string<uuid>

customer.name

string | null

Customer name

Maximum string length: 100

customer.email

string | null

Maximum string length: 100

plan_items

PlanItemOut · object[]

List of plan items associated with this contract

Show child attributes

plan_items.name

string

required

Maximum string length: 255

plan_items.billing_alias

string | null

The billing alias for this plan item

Example:

"api_calls"

plan_items.prices

PlanItemPriceOut · object[]

List of prices for this plan item

Show child attributes

plan_items.prices.price

number | null

The price of the plan item

Example:

99.99

plan_items.prices.billing_cycle

string | null

The billing cycle for this price

Example:

"monthly"

plan_items.prices.price_type

string | null

The type of price (fixed_fee, usage_based_fee, tiered_fee, etc.)

Example:

"fixed_fee"

plan_items.prices.minimum_spend

number | null

Minimum amount to be charged for usage-based pricing

Example:

100

plan_items.prices.minimum_units

number | null

Minimum number of units to be billed if usage is below this threshold

Example:

1000

plan_items.prices.allocated_units

number | null

Number of units allocated before overage charges apply

Example:

10000

plan_items.prices.uuid

string<uuid>

plan_items.uuid

string<uuid>

plan_items.description

string | null

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

currency

string

default:USD

Maximum string length: 3

payment_terms

string | null

Maximum string 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

Contract List Api Contract Line Items Api

⌘I

API Documentation

Authorizations

Path Parameters

Response