Proposals

Commercial proposals — from draft to acceptance, where a signature becomes a subscription — and the templates they are rendered from.

Families on this page

Family	Tools	read	write	destructive
proposals — Proposals	25	7	11	7
templates — Proposal templates	9	2	6	1

proposals

Tool	Kind	Permission	Endpoint	What it does
billing_proposals_list	read	proposals.list	GET /v1/proposals	List commercial proposals.
billing_proposals_get	read	proposals.show	GET /v1/proposals/:id	Fetch one proposal with its items and totals.
billing_proposals_create	write	proposals.create	POST /v1/proposals	Create a draft proposal.
billing_proposals_upsert	write	proposals.create	PUT /v1/proposals	Create or update a proposal matched on id → external_id → code.
billing_proposals_update	write	proposals.update	PATCH /v1/proposals/:id	Update a proposal.
billing_proposals_delete	destructive	proposals.delete	DELETE /v1/proposals/:id	Soft-delete a proposal.
billing_proposals_publish	write	proposals.update	POST /v1/proposals/:id/publish	Publish a proposal, making its public link reachable by the prospect.
billing_proposals_unpublish	destructive	proposals.update	POST /v1/proposals/:id/unpublish	Take a proposal offline; the public link stops resolving.
billing_proposals_send	write	proposals.send	POST /v1/proposals/:id/send	E-mail a proposal to its contact and move it to sent.
billing_proposals_accept	write	proposals.approve	POST /v1/proposals/:id/accept	Accept a proposal on behalf of the customer.
billing_proposals_undo_accept	destructive	proposals.approve	POST /v1/proposals/:id/undo-accept	Undo an acceptance, sending the proposal back to sent.
billing_proposals_cancel	destructive	proposals.update	POST /v1/proposals/:id/cancel	Cancel a proposal.
billing_proposals_duplicate	write	proposals.create	POST /v1/proposals/:id/duplicate	Copy a proposal and its items into a new draft.
billing_proposals_generate_pdf	write	proposals.update	POST /v1/proposals/:id/generate-pdf	Render the proposal PDF from its template and store it.
billing_proposals_pricing	read	proposals.show	GET /v1/proposals/:id/pricing	Price breakdown of a proposal on every billing cycle: setup, monthly, cycle discount and total — what the prospect sees before picking one.
billing_proposals_json	read	proposals.show	GET /v1/proposals/:id/json	The full proposal payload as the template renderer receives it — the merge data behind the PDF.
billing_proposals_stats	read	proposals.list	GET /v1/proposals/stats	Aggregate proposal counts and values by status, for the whole organization.
billing_proposals_items_list	read	proposals.show	GET /v1/proposals/:id/items	List the items of a proposal.
billing_proposals_items_create	write	proposals.update	POST /v1/proposals/:id/items	Add an item to a draft proposal.
billing_proposals_items_get	read	proposals.show	GET /v1/proposals/:id/items/:itemId	Fetch one proposal item with its negotiated pricing.
billing_proposals_items_update	write	proposals.update	PATCH /v1/proposals/:id/items/:itemId	Update one item of a draft proposal.
billing_proposals_items_delete	destructive	proposals.update	DELETE /v1/proposals/:id/items/:itemId	Remove an item from a draft proposal.
billing_proposals_bulk_send	write	proposals.send	POST /v1/proposals/bulk-send	Send up to 100 proposals in one call.
billing_proposals_bulk_cancel	destructive	proposals.update	POST /v1/proposals/bulk-cancel	Cancel up to 100 proposals in one call.
billing_proposals_bulk_delete	destructive	proposals.delete	POST /v1/proposals/bulk-delete	Soft-delete up to 100 proposals in one call.

templates

Tool	Kind	Permission	Endpoint	What it does
billing_proposal_templates_list	read	templates.list	GET /v1/proposal_templates	List the templates proposals are rendered from.
billing_proposal_templates_get	read	templates.show	GET /v1/proposal_templates/:id	Fetch one proposal template.
billing_proposal_templates_create	write	templates.create	POST /v1/proposal_templates	Create a proposal template.
billing_proposal_templates_upsert	write	templates.create	PUT /v1/proposal_templates	Create or update a proposal template matched on id → external_id → name.
billing_proposal_templates_update	write	templates.update	PATCH /v1/proposal_templates/:id	Update a proposal template.
billing_proposal_templates_delete	destructive	templates.delete	DELETE /v1/proposal_templates/:id	Soft-delete a proposal template.
billing_proposal_templates_activate	write	templates.update	POST /v1/proposal_templates/:id/activate	Make a template selectable on new proposals.
billing_proposal_templates_deactivate	write	templates.update	POST /v1/proposal_templates/:id/deactivate	Hide a template from new proposals.
billing_proposal_templates_duplicate	write	templates.create	POST /v1/proposal_templates/:id/duplicate	Copy a proposal template into a new one, ready to be edited.

---

The fields of each resource are in the API reference and in billing_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.