Skip to main content
POST
Create Contract

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
config_items
object[]
required
customer_id
string
required

The customer attached to the contract

signatories
object[] | null
required

The signatories for the contract

start_type
enum<string>
required

The start type for the contract, one of SPECIFIC_DATE, ON_COMPLETION or MANUAL_ACTION

Available options:
SPECIFIC_DATE,
ON_COMPLETION,
MANUAL_ACTION
template_id
string
required

The template to use for the contract

title
string
required

The title for the contract

type
enum<string>
required

The type of the proposal

Available options:
CONTRACT
auto_charges
null | boolean

Whether the subscription is automatically charged to the payment method after the contract is signed

auto_renews
null | boolean

Whether this subscription auto renews at the end of the term. This is to be used without end date or renewal date

billing_anchor_date
null | string<date-time>

The billing anchor date for the subscription in RFC-3339 format, defaults to the start date

bundle_pricing_id
null | string

The bundle that form the contract.

custom_variables
object | null

The custom variables for the contract as key-value pairs

discounts
object[] | null

The discounts attached to the contract

expiration_date
null | string<date-time>

The expiration date for the contract in RFC-3339 format

metadata
object

Any additional data as key-value pairs that needs to be attached to the subscription after the contract is signed

onetime_items
object[] | null

Any one time charges to be attached to the contract

options
object | null

The detailed options for the contract such as confirmation messages, redirect urls etc.

owner_id
string | null

The company user ID of the user in Measure assigned to manage this contract

product_pricing_ids
string[] | null

The list of product pricings that form the contract. At least one of bundle_pricing_id, product_pricing_ids or onetime_items must be provided

require_payment_method
null | boolean

Whether the contract requires a payment method to be executed

sales_user_id
string | null

The sales user ID assigned to this contract

start_date
null | string<date-time>

The start date for the contract in RFC-3339 format, if it does not start immediately

status
null | enum<string>

The status of the contract, defaults to DRAFT

Available options:
DRAFT,
PENDING_SIGNATURES
term
object

The term for the subscription created by the contract

trial
null | boolean

Whether the contract creates a subscription in a trial

trial_term
object

The trial term for the subscription after the contract is executed

Response

200 - application/json

OK

acv
object

The amount which has value in cents and a currency

auto_charges
boolean
auto_renews
boolean
billing_anchor_date
null | string<date-time>
bundle_pricing
object
bundle_pricing_id
string
campaigns
object[] | null
change_custom_date
null | string<date-time>
change_proration_type
string | null
change_reset_billing_anchor
null | boolean
change_timing
string | null
company
object
company_id
string
completed_date
null | string<date-time>
config_items
object[] | null
content
null | string
content_template
null | string
contract_attachments
object[] | null
counter_signatories
object[] | null
created_at
string<date-time>
currency
string | null
custom_variables
object | null
customer
object
customer_id
null | string
description
null | string
discounts
object[] | null
error_status_details
object[] | null
expiration_date
null | string<date-time>
finalized_date
null | string<date-time>
follow_up
null | string
follow_up_data
object
id
string
invoice_due_date_from_creation
null | integer
Required range: x >= 0
invoice_event_grace_period
null | integer
Required range: x >= 0
invoice_payment_instructions
null | string

Payment instructions attached to each invoice generated for the contract. If non-null, overrides the invoice payment instructions set at the company-wide setting.

metadata
object
minimum_spend
object

The amount which has value in cents and a currency

one_time_billables
object[] | null
options
object
owner
object
owner_id
null | string
parent_billed
boolean
payment_config
object
payment_data
object
payment_provided_date
null | string<date-time>
po_number
null | string
previous_arr
object

The amount which has value in cents and a currency

previous_sub_change
object[]
previous_subscription
object
previous_subscription_id
null | string
processing_date
null | string<date-time>
quote_plans
null | object[]
require_payment_method
boolean
requires_customer_confirmation
boolean
sales_user
object

The commissionable user if there is one present

sales_user_id
null | string

The ID of the commissionable user if there is one present

scheduled_changes
object[] | null
selected_plan_id
null | string
signatories
object[] | null
signed_date
null | string<date-time>
signed_file_id
null | string
signed_offline
boolean
start_date
null | string<date-time>
start_type
string
status
string
subscription
object
subscription_id
null | string
tcv
object

The amount which has value in cents and a currency

template_id
null | string
template_variables
string[] | null
term
object

The term which includes a frequency interval and a count for number of intervals

title
string
trial
boolean
trial_term
object

The term which includes a frequency interval and a count for number of intervals

type
string
updated_at
string<date-time>
variable_configs
object[] | null