API Reference
Advancehq.com

Create new plan

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

Creates a new plan. Payment link is created and invoice PDF is generated.

Body Params

Request body for creating a new plan via the public API. All plans created via the public API are immediately set to open status.

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. Online checkout methods are 'checkout_ach' and 'checkout_credit_card'; offline methods are 'ach' (manual bank transfer) and 'check'. If you omit any checkout_* method, both online methods are enabled by default. To offer only one online method, pass just that value (e.g. ['checkout_credit_card']). Add 'ach' or 'check' to also accept manually-recorded offline payments.

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 the insured this plan bills. The recipient name and email are still sent on the plan itself.

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). Reminders are scheduled from it, and an unpaid plan past it is listed as overdue.

policies
array of objects | null

List of insurance policies to include on this plan. Each policy requires at least a market_id.

Policies
string | null

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

string | null

Email address of the invoice recipient, used for reminders and when the invoice is emailed. Required to create a plan.

string | null

Display name of the person or company receiving the invoice. Required to create a plan.

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
boolean
Defaults to false

Email the invoice and its payment link to the recipient once the plan is created, copying cc_emails.

string | null

Email shown as the sender on the invoice.

string | null

Name shown as the sender on the invoice. Required to create a plan.

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 4 months 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 4 months ago

Did this page help you?