Create subscription checkout

📘
API Refs

Staging: Create subscription checkout

Request body

Name	Type	Description	Required
policyholderId	number	ID of the policyholder for this subscription	yes
carrierId	number	ID of the insurance carrier	yes
planId	number	The ID of the subscription plan/price	yes
customerEmail	string	Customer email address	yes
grossPremium	number	Gross premium amount (2 decimal places)	yes
effectiveDate	date	Effective date of the invoice	yes
expirationDate	date	Expiration date of the invoice	yes
customerName	string	Customer name for subscription	no
successUrl	string	URL to redirect after successful subscription	no
cancelUrl	string	URL to redirect after cancelled subscription	no
metadata	object	Custom key-value pairs for analytics (see API for details)	no
isAutoRemitPremiums	boolean	Auto-remit premiums for created invoices	no
serviceFee	number	Service fee amount for invoices	no
taxes	number	Tax amount for invoices	no
commission	number	Commission override amount	no
numDaysForAutoRemind	number	Days for auto-reminder notifications	no
memo	string	Custom memo prefix (max 200 chars)	no
brokerCode	string	Broker code (max 50 chars)	no
shouldBeSigned	boolean	Whether invoices should be signed	no
isCommissionVisibleForPolicyholder	boolean	Show commission to policyholder	no
mgaId	number	MGA ID	no
policyId	string	External policy ID (max 50 chars)	no
downPayment	number	Down payment amount	no
financeAmount	number	Finance amount	no

Response

Returns a checkout session object containing:

url: The hosted checkout page URL to redirect your customer to
expires_at: When this checkout session expires

Description

This endpoint creates a hosted checkout link where customers can securely enter their payment information and subscribe to your plans. This is ideal for redirecting users from your website or sending subscription links via email. The checkout page handles all payment collection, validation, and subscription creation automatically.