Skip to main content
GET
/
contract_v2
/
{contract_id}
Get contract by ID
curl --request GET \
  --url https://api.zenskar.com/contract_v2/{contract_id} \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Enterprise Plan - Q1 2025",
  "description": "12-month enterprise subscription",
  "status": "active",
  "currency": "USD",
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-12-31T23:59:59Z",
  "customer_id": "987fcdeb-51a2-43d7-9876-543210fedcba",
  "customer": {
    "id": "987fcdeb-51a2-43d7-9876-543210fedcba",
    "customer_name": "Acme Corporation",
    "email": "billing@acme.com"
  },
  "phases": [
    {
      "id": "456e7890-e89b-12d3-a456-426614174111",
      "name": "Standard Phase",
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2025-12-31T23:59:59Z",
      "phase_type": "active",
      "pricings": []
    }
  ],
  "custom_attributes": {
    "sales_rep": "john.doe@company.com",
    "deal_id": "DEAL-2025-001"
  },
  "created_at": "2025-01-01T10:30:00Z",
  "updated_at": "2025-01-15T14:20:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

​
contract_id
string<uuid>
required

Response

Contract retrieved successfully

​
id
string<uuid>
required

Unique identifier for this contract

​
name
string
required

Human-readable name for the contract. Used for identification and reporting purposes.

​
status
enum<string>
required

Current status of the contract (e.g., active, draft, expired, terminated). System automatically updates to 'expired' when end_date is reached.

Available options:
draft,
active,
paused,
expired,
disputed
​
currency
string
required

Three-letter ISO 4217 currency code for all monetary amounts in this contract (e.g., 'USD', 'EUR', 'GBP').

​
created_at
string<date-time>
required

Timestamp when this contract was created in the system. Used for audit trails and reporting.

​
updated_at
string<date-time>
required

Timestamp of the last modification to this contract. Updates whenever any field or related entity changes.

​
customer_id
string<uuid>
required

Unique identifier of the customer who is party to this contract.

​
customer
CustomerResponseSchema · object
required

Complete customer details including name, contact information, and billing preferences. The customer who is party to this contract.

​
description
string | null

Detailed description of the contract terms, scope, or special conditions.

​
tags
any[] | null

List of tags for categorizing and filtering contracts. Useful for reporting and segmentation.

​
start_date
string<date-time> | null

Date when the contract became or will become active. Billing and revenue recognition calculations start from this date.

​
end_date
string<date-time> | null

Date when the contract expires. Null indicates an indefinite contract that continues until manually terminated.

​
custom_attributes
Custom Attributes · object

Organization-specific metadata stored as key-value pairs. Can include fields like sales_rep, deal_id, region, or any custom data needed for reporting and integrations.

​
source
Source · object

Metadata about the originating system or process that created this contract. Used for integration tracking and audit trails.

​
anchor_date
string<date-time>

Reference date for billing cycle calculations. When set, billing cycles align to this date regardless of contract start date.

​
is_last_day_of_month
boolean | null

When true, billing cycles always end on the last day of the month, adjusting for varying month lengths.

​
plan_id
string<uuid> | null

Reference to the plan template used to create this contract, if applicable.

​
renewal_policy
enum<string> | null
default:do_not_renew

Defines contract renewal behavior. Currently only 'do_not_renew' is supported—contracts must be manually renewed or replaced.

Available options:
renew_with_default_contract,
renew_with_existing,
do_not_renew
​
phases
ContractPhaseResponseSchema · object[] | null

List of contract phases defining distinct periods with different terms, products, or pricing. Sorted chronologically by start date.

​
invoice_payer_customer
CustomerResponseSchema · object

Customer details for the invoice payer, if different from the contract customer. Used when one entity uses services but another pays for them.

​
current_phase
PhaseDetails · object

The contract phase that is currently active based on today's date. Null if no phase is active or contract hasn't started.

​
contract_link
string | null

URL to external contract document, signed agreement, or related resource.

​
bill_parent_customer
boolean | null
default:false

When true and customer has a parent relationship, invoices are sent to the parent customer instead.

​
invoice_payer_customer_id
string<uuid> | null

Customer ID who will receive and pay invoices for this contract, if different from the contract customer.