Skip to main content
PATCH
Update Proposal

Authorizations

Authorization
string
header
required

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

Scopes

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_'.

id
string
required

The resource ID

Body

application/json
auto_charges
null | boolean

Whether the subscription is automatically charged to the payment method after the checkout session

available_payment_methods
null | string[]

List of available payment methods

billing_anchor_date
object
customer_id
null | string

The customer ID for this quote

description
null | string

Detailed description of the quote

expiration_date
object

The expiration date for the quote in RFC-3339 format

file_attachment_ids
string[] | null

Document IDs to attach

finalize
boolean
follow_up
null | enum<string>

Follow-up action after plan selection

Available options:
CREATE_CONTRACT,
NONE,
CREATE_PAYMENT_LINK
follow_up_data
object

Configuration data for the follow-up action

invoice_due_date_from_creation
null | integer

Invoice due date from creation in days

Required range: x >= 0
invoice_payment_instructions
string | null

Payment instructions for the invoice

overridden_payment_method_types
null | (null | string)[]

List of overridden payment method types

overridden_payment_method_types_enabled
null | boolean

Whether payment method types are overridden

overridden_payment_method_types_rules
null | object[]

Rules for overridden payment method types

owner_id
string | null

The company user ID of the user assigned to manage this quote

payment_provider_integration_id
null | string

The payment provider integration ID

quote_plans
object[]

Array of pricing plans to present to the customer

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 quote

start_date
object

Start date in RFC-3339 format

start_type
null | enum<string>
Available options:
SPECIFIC_DATE,
ON_COMPLETION,
MANUAL_ACTION
title
null | string

The title for the quote

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