Subscriptions

Create subscription line item

Changed on

Use when adding a new charge or seat to a subscription (e.g. extra seat or one-time add). Supports price_id or inline price.

post/subscriptions/{id}/lineitems

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/subscriptions/{id}/lineitems
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Subscription ID

Request body

commitment_amountnumber

Commitment fields

commitment_duration'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME'
commitment_overage_factornumber
commitment_quantitynumber
commitment_true_up_enabledboolean
commitment_type'amount' | 'quantity'
commitment_windowedboolean
display_namestring
end_datestring date-time
metadataobject
price_idstring

PriceID references an existing price (plan, addon, or subscription-scoped). Exactly one of price_id or price must be set.

proration_behavior'create_prorations' | 'none'
quantitynumber
start_datestring date-time
subscription_phase_idstring

Response

Created

addon_association_idstring
billing_period'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME'
billing_period_countinteger

from price at create; default 1

commitment_amountstring

Commitment fields

commitment_duration'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME'
commitment_overage_factorstring
commitment_quantitystring
commitment_true_up_enabledboolean
commitment_type'amount' | 'quantity'
commitment_windowedboolean
created_atstring date-time
created_bystring
currencystring
customer_idstring
display_namestring
end_datestring date-time
entity_idstring
entity_type'plan' | 'addon' | 'subscription'
environment_idstring
idstring
invoice_cadence'ARREAR' | 'ADVANCE'
metadataobject
meter_display_namestring
meter_idstring
plan_display_namestring
price_idstring
price_type'USAGE' | 'FIXED'
price_unitstring
price_unit_idstring
quantitystring
start_datestring date-time
status'published' | 'deleted' | 'archived'
subscription_idstring
subscription_phase_idstring
tenant_idstring
updated_atstring date-time
updated_bystring

Changes

  • e1d4e27b5677Revision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • 9cd0dab91f5cRevision changes
    • info

      added the optional property // to the response with the status