Create subscription

📘
API Refs

Staging: Create subscription

Request body

Name	Type	Description	Required
customer	string	The Stripe CustomerID	yes
items	array	Array of subscription items with price and quantity	yes
policyholderId	number	The policyholder ID from contact catalog	yes
carrierId	number	The carrier ID from contact catalog	yes
grossPremium	number	Gross premium amount (2 decimal places)	yes
effectiveDate	date	Effective date of the subscription/policy	yes
expirationDate	date	Expiration date of the subscription/policy	yes
payment_behavior	string	Stripe payment behavior (e.g., default_incomplete)	no
expand	array	Fields to expand in Stripe response	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

A successful request returns a 201 Created status code with the created subscription details including:

StripeSubscriptionID
Current status
Customer information
Plan details
Billing cycle information
Next payment date

Description

This endpoint creates a new subscription for an existing customer. The customer must already exist in your system and have a valid payment method on file. Use this endpoint when you want to programmatically subscribe customers to your plans.