Subscriptions

Update subscription line item

Changed on

Use when changing a subscription line item (e.g. quantity or price). Implemented by ending the current line and creating a new one for clean billing.

put/subscriptions/lineitems/{id}

Request

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

Path parameters

idstring required

Line Item ID

Request body

amountstring

Amount is the new price amount that overrides the original price

billing_model'FLAT_FEE' | 'PACKAGE' | 'TIERED'
bucket_size'MINUTE' | '15MIN' | '30MIN' | 'HOUR' | '3HOUR' | '6HOUR' | '12HOUR' | 'DAY' | 'WEEK' | 'MONTH'
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
effective_fromstring

EffectiveFrom for the existing line item (if not provided, defaults to now)

metadataobject

Metadata for the new line item

price_unit_amountstring

PriceUnitAmount is the amount for a CUSTOM price unit price (FLAT_FEE/PACKAGE billing models)

tier_mode'VOLUME' | 'SLAB'

Response

OK

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

  • 10dafa79be22Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 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