Skip to main content
PATCH
/
contract_v2
/
{contract_id}
/
pause
Update pause contract
curl --request PATCH \
  --url https://api.zenskar.com/contract_v2/{contract_id}/pause \
  --header 'Content-Type: application/json' \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "pause_phase_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unpause_extension_policy": "extend"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "draft",
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "customer_name": "<string>",
    "custom_data": {},
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "validation_status": "<string>",
      "connector_validation": {}
    },
    "ship_to_address": {
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "validation_status": "<string>",
      "connector_validation": {}
    },
    "tax_info": [],
    "email": "<string>",
    "custom_attributes": {},
    "phone_number": "<string>",
    "communications_enabled": true,
    "auto_charge_enabled": true,
    "business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "description": "<string>",
  "tags": [
    "<unknown>"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "custom_attributes": {},
  "source": {},
  "anchor_date": "2023-11-07T05:31:56Z",
  "is_last_day_of_month": true,
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "renewal_policy": "do_not_renew",
  "phases": [],
  "invoice_payer_customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "customer_name": "<string>",
    "custom_data": {},
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "validation_status": "<string>",
      "connector_validation": {}
    },
    "ship_to_address": {
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "validation_status": "<string>",
      "connector_validation": {}
    },
    "tax_info": [],
    "email": "<string>",
    "custom_attributes": {},
    "phone_number": "<string>",
    "communications_enabled": true,
    "auto_charge_enabled": true,
    "business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "current_phase": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "phase_type": "active",
    "phase_metadata": {}
  },
  "contract_link": "<string>",
  "bill_parent_customer": false,
  "invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Body

application/json
​
start_date
string<date-time>
required

Start Date

​
end_date
string<date-time> | null

End Date

​
pause_phase_id
string<uuid> | null

Pause Phase ID

​
unpause_extension_policy
enum<string> | null

Unpause Extension Policy

Available options:
extend,
overlap

Response

Successful Response

​
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.