Create subscription

AutoInvoiceThreshold is the usage amount (in subscription currency) that triggers an intermediate invoice mid-period. Set once at creation; cannot be changed later. Allowed only when the subscription resolves to type standalone (no parent hierarchy rows). Plan line items must be usage-based only (no fixed or other non-usage plan prices). Nil means auto invoice threshold billing is disabled for this subscription.

BillingAnchor overrides the derived billing anchor when billing_cycle is anniversary. For monthly billing, the day-of-month (and time-of-day) define cycle boundaries: if start_date is before that day in the month, the first billing period ends on the next occurrence of that day in the same month (a shorter first period); subsequent periods follow the usual interval.

CommitmentAmount is the minimum amount a customer commits to paying for a billing period

customer_id is the flexprice customer id and it is prioritized over external_customer_id in case both are provided.

Enable Commitment True Up Fee

external_customer_id is the customer id in your DB and must be same as what you provided as external_id while creating the customer in flexprice.

OverageFactor is a multiplier applied to usage beyond the commitment amount

Timezone of the customer. If not set, the default value is UTC.

TrialPeriodDays: nil = inherit trial length from plan recurring-fixed prices (must be uniform). 0 = explicitly no trial (overrides catalog). >0 = override duration in days.

ActivePauseID references the current active pause configuration This will be null if no pause is active or scheduled

AutoInvoiceThreshold is the usage amount (in subscription currency) that triggers an intermediate invoice. Overrides the plan-level threshold when set. Nil means: inherit from the plan's threshold (which may also be nil = disabled).

BillingAnchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.

BillingPeriodCount is the total number units of the billing period.

CancelAt is the date the subscription will be canceled

CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period

CanceledAt is the date the subscription was canceled

CollectionMethod determines how invoices are collected

CommitmentAmount is the minimum amount a customer commits to paying for a billing period

Currency is the currency of the subscription in lowercase 3 digit ISO codes

CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

CurrentPeriodStart is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

CustomerID is the identifier for the customer in our system

EndDate is the end date of the subscription

EnvironmentID is the environment identifier for the subscription

GatewayPaymentMethodID is the gateway payment method ID for this subscription

ID is the unique identifier for the subscription

InvoicingCustomerID is the customer ID to use for invoicing This can differ from the subscription customer (e.g., parent company invoicing for child company)

LookupKey is the key used to lookup the subscription in our system

OverageFactor is a multiplier applied to usage beyond the commitment amount

ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)

PaymentBehavior determines how subscription payments are handled

PlanID is the identifier for the plan in our system

StartDate is the start date of the subscription

SyncedPriceSequence is the plan-price sequence up to which this subscription's line items have been reconciled. Bumped by the plan-price sync after a successful pass.

TrialEnd is the end date of the trial period

TrialStart is the start date of the trial period

Version is used for optimistic locking