API Reference
Advancehq.com

Update a plan

put
https://api.advancehq.com/v1/plans/

Corrects an open plan in place, keeping its plan number and payment link, and issues a new invoice PDF. Fields you leave out keep their value; policies replaces the plan's policies in full.

Path Params
string
required
Body Params

Request body for correcting an open plan in place via the public API.

Same fields as plan creation. A field left out keeps its current value; policies is the
exception and replaces the plan's policies in full. The recipient and sender names and the
recipient email are required, as an open plan's invoice needs them (the edit validates the body).

agency_fees
array of objects | null
deprecated

DEPRECATED: Use per-policy agency fees instead. Kept for backward compatibility only.

Agency Fees
allowed_payment_methods
array of objects | null

Payment methods to accept. Leave it out to keep the plan's current methods. When sent, it follows the same rules as plan creation: omitting every checkout_* method enables both online methods, and 'ach' or 'check' add offline methods.

Allowed Payment Methods
Allowed:
string
enum
Defaults to direct
Allowed:
cc_emails
array of strings | null

Additional email addresses to CC the invoice file.

Cc Emails
check_mailing_address
object

Where checks for this plan are mailed. Defaults to the agency's check mailing address from Settings when left out; null prints no address.

string | null

Who checks for this plan are payable to. Defaults to the agency's check payee from Settings.

string | null

ID of an existing insured record. If provided, recipient fields are populated from the insured.

date-time | null

Date shown on the generated invoice (ISO 8601). Defaults to the plan's creation time when omitted. Distinct from created_at, which always records when the plan was written to the database — imports of past statements set an earlier invoice_date while created_at stays the import time.

string | null
Defaults to Invoice

Header text shown at the top of the invoice. Defaults to 'Invoice'.

string | null

Free-text notes displayed on the invoice, visible to the recipient.

string | null
date-time | null

Payment due date (ISO 8601). Used to trigger overdue status and reminder notifications.

policies
array of objects
required
length ≥ 1

The plan's full list of policies. It replaces the current policies, so send every policy the plan should keep.

Policies*

Policy object for use in public API plan creation.

additional_policy_items
array of objects

Extra line items added to the policy total. Each has 'name' and 'amount'.

Additional Policy Items
agency_fees
array of objects | null

Agency fees specific to this policy.

Agency Fees
string | null
deprecated

Deprecated: use market_id instead. ID of the insurance market underwriting this policy.

Commission percentage.

date-time | null

Date coverage begins (ISO 8601)

string | null

Policy event type, e.g. 'new' or 'renew', 'cancel' or 'endorsement'

date-time | null

Date coverage ends (ISO 8601)

fees
object

Fee line item. Object with 'name' and 'amount'.

string | null

ID of the insurance market underwriting this policy.

string | null

Display name or description of this policy (e.g. 'General Liability')

string | null

Policy number as issued by the market

premium
object

Premium line item. Object with 'name' (label) and 'amount' (dollars).

Producer commission amount. Set either percentage or amount, not both. If both are provided, amount takes precedence.

Producer commission percentage. Set either percentage or amount, not both. If both are provided, amount takes precedence.

string | null

Producer for this policy. Direct Bill: can differ per policy. Agency Bill: mirrors the plan-level producer, written at creation time.

string | null

Market product line name used to look up the applicable commission rate

string | null
Defaults to open

Policy status. Defaults to 'open'.

surplus_fees_lines
array of objects | null

Surplus fee line items for this policy.

Surplus Fees Lines
surplus_tax_lines
array of objects | null

Surplus tax line items for this policy.

Surplus Tax Lines
taxes
object

Tax line item. Object with 'name' and 'amount'.

string | null

ID of the producer associated with this plan. Required for commission tracking.

string
required

Email address of the invoice recipient.

string
required

Name of the invoice recipient.

string | null

Recipient phone number (max 20 characters).

reminder_days
array of integers | null

List of days before (-) or after (+) payment due date to send reminders. Max 4 reminders.

Reminder Days
string | null

Email shown as the sender on the invoice.

string
required

Name of the sender shown on the invoice.

surplus_fees_lines
array of objects | null
deprecated

DEPRECATED: Use per-policy surplus fee lines instead. Kept for backward compatibility only.

Surplus Fees Lines
surplus_tax_lines
array of objects | null
deprecated

DEPRECATED: Use per-policy surplus tax lines instead. Kept for backward compatibility only.

Surplus Tax Lines
surplus_taxes
object
deprecated

DEPRECATED: Use per-policy surplus taxes instead. Kept for backward compatibility only.

boolean | null
Defaults to false
Responses

Updated 12 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago

Did this page help you?