latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs

stripe-subscriptions

Create Enterprise Subscription

Create a Stripe subscription for enterprise client onboarding.

Supports multiple line items, trial periods, and billing controls. Automatically attaches client_id and product_id metadata.

post/api/v1/admin/stripe-subscriptions

client_idstring uuid required

CAMS client UUID — used to look up Stripe customer and auto-populate metadata

product_idstring uuid nullable

CAMS product UUID for metadata. If omitted, defaults to the platform (Insights Platform) product.

subscription_start_datestring date-time nullable

When the subscription period begins (Duration in Stripe)

billing_start_datestring date-time nullable

When billing starts (used as trial_end — supports dates beyond 30 days)

cancel_atstring date-time nullable

Scheduled cancellation date

trial_period_daysinteger nullable

collection_method'charge_automatically' | 'send_invoice' nullable

days_until_dueinteger nullable

Days until invoice due (defaults to 30 for send_invoice)

payment_behavior'default_incomplete' | 'allow_incomplete' | 'error_if_incomplete' nullable

Successful Response

idstring required

customerstring nullable

statusstring nullable

current_period_startinteger nullable

current_period_endinteger nullable

cancel_atinteger nullable

trial_endinteger nullable

collection_methodstring nullable

metadataobject

itemsobject[]

livemodeboolean nullable