Create subscription

post

https://claims-test.snaprefund.io/api/public/subscriptions

Creates a new subscription for a customer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Subscription configuration including customer and plan details

effectiveDate

date-time

required

Effective date of the policy/subscription

expirationDate

date-time

required

Expiration date of the policy/subscription

stripeCustomerId

string

required

The Stripe customer ID (must start with "cus_")

stripePriceId

string

required

The Stripe price ID for the subscription plan (must start with "price_")

policyholderId

number

required

The policyholder ID from contact catalog

carrierId

number

required

The carrier ID from contact catalog

isAutoRemitPremiums

boolean

Whether to automatically remit premiums for invoices created from this subscription

serviceFee

number

Service fee amount to be applied to invoices created from this subscription

taxes

number

Tax amount to be applied to invoices created from this subscription

commission

number

Commission amount to override default calculation for invoices created from this subscription

numDaysForAutoRemind

number

Number of days for auto-reminder notifications

memo

string

length ≤ 200

Custom memo prefix for invoices created from this subscription

brokerCode

string

length ≤ 50

Broker code associated with this subscription

shouldBeSigned

boolean

Whether invoices created from this subscription should be signed

isCommissionVisibleForPolicyholder

boolean

Whether commission should be visible to policyholder in invoices created from this subscription

mgaId

number

ID of the MGA.

policyId

string | null

External policy ID.

downPayment

number | null

Down payment amount.

financeAmount

number | null

Finance amount.

paymentMethod

string

enum

required

Required payment method for the subscription. This determines fee structures and payment processing. Only card and us_bank_account are supported.

Allowed:

billingPortalReturnUrl

string

URL used as the return URL for the Stripe billing portal. When customers access the billing portal to manage their subscription, they will be redirected to this URL when they exit the portal. This is NOT used for initial payment redirect.

checkoutSuccessUrl

string

required

URL to redirect to after successful payment completion in the Stripe Checkout Session. This URL will be used when the customer successfully completes payment for the subscription.

checkoutCancelUrl

string

URL to redirect to when the customer cancels the payment in the Stripe Checkout Session. This URL will be used when the customer cancels the checkout process.

Responses

400

Invalid subscription configuration

401

Invalid or missing authorization token

403

Insufficient permissions

201Successfully created subscription