API Reference
Book a Demo

Update contract

put
https://api.zenskar.com/contract_v2/

Update an existing contract with new details.

Allows modification of contract terms including name, status, dates, currency, customer, phases, and custom attributes. All fields from the create schema are supported. This operation replaces the entire contract, so include all fields you want to retain.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required
Defaults to Annual Subscription - Acme Corp

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

Detailed description of the contract terms, scope, or special conditions. Displayed in contract details and reports.

tags

Optional list of tags for categorizing and filtering contracts (e.g., ['enterprise', 'annual', 'discounted']). Useful for reporting and segmentation.

string
enum
required
Defaults to active

Contract status. Only 'active' and 'draft' are accepted. Other statuses (expired, paused) are managed via dedicated endpoints.

Allowed:
string
required
Defaults to USD

Three-letter ISO 4217 currency code for all monetary amounts in this contract (e.g., 'USD', 'EUR', 'GBP'). Must match customer's billing currency or be explicitly configured.

date-time
required
Defaults to 2025-01-01T00:00:00

Date when the contract becomes active and billing begins. Must be in ISO 8601 format. Used as the basis for billing cycle calculations and revenue recognition.

Optional date when the contract expires. If not provided, contract continues indefinitely until manually terminated. Must be after start_date. Used for automatic expiration and renewal calculations.

uuid
required
Defaults to 123e4567-e89b-12d3-a456-426614174000

The unique identifier of the customer who is party to this contract. Customer must exist in the system before contract creation.

date-time

Reference date for billing cycle calculations. When set, all billing cycles align to this date regardless of contract start. Useful for ensuring consistent billing dates across multiple contracts.

When true, billing cycles always end on the last day of the month, adjusting for varying month lengths. Commonly used for monthly subscriptions billed on the last day.

custom_attributes

Flexible key-value store for organization-specific metadata. Can include fields like sales_rep, deal_id, region, or any custom data needed for reporting and integrations.

phases

List of contract phases defining distinct periods with different terms, products, or pricing. Common use cases include trial periods, promotional pricing, or stepped pricing models. Phases must not overlap and must fall within contract date boundaries.

enum

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

URL to external contract document, signed agreement, or related resource. Useful for maintaining references to legal documents stored in external systems.

When true and customer has a parent relationship, invoices are sent to the parent customer instead. Used for hierarchical billing scenarios like subsidiaries or franchises.

Optional customer ID who will receive and pay invoices for this contract, if different from the contract customer. Used when one entity uses services but another pays for them.

When true, this contract is eligible for renewal processes. Set to false to exclude from automatic renewal workflows.

source

Metadata about the originating system or process that created this contract. Commonly includes fields like 'system', 'opportunity_id', or 'contract_number' for integration tracking and audit trails.

Responses

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago