Sign in
Subscriptions

Delete subscription line item

Use when removing a charge or seat from a subscription (e.g. downgrade). Line item ends; retained for history but no longer billed.

delete/subscriptions/lineitems/{id}

Path parameters

idstring required

Line Item ID

Request body

effective_fromstring
proration_behavior'create_prorations' | 'none'

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

Changed in 6 of the 12 revisions of this API.1717

  • cef2964c102c23See the full diff
    • ●

      added the new config enum value to the price/addon/entitlements/items/feature/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new config enum value to the price/addon/entitlements/items/feature_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property commitment_time_buckets to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property price/addon/entitlements/items/config_value to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property price/sequence to the response with the 200 status

      response-optional-property-added

  • f62d8a5fe7cf4See the full diff
    • ●

      removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • ●

      added the new too_many_requests enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new too_many_requests enum value to the code response property for the response status 500

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0cb3425d658053See the full diff
    • ●

      removed the optional property price/addon/type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property trial_period_days from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new ONETIME enum value to the billing_period response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ONETIME enum value to the commitment_duration response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ONETIME enum value to the price/billing_period response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property proration_behavior

      new-optional-request-property

    • ○

      added the optional property addon_association_id to the response with the 200 status

      response-optional-property-added

    • ○

      removed the ONETIME enum value from the price/billing_cadence response property for the response status 200

      response-property-enum-value-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 82f205e0f42922See the full diff
    • ●

      removed the optional property price/trial_period from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property trial_period from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property price/trial_period_days to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property trial_period_days to the response with the 200 status

      response-optional-property-added

  • 4ded3711f40148See the full diff
    • ●

      removed the optional property error from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property error from the response with the 500 status

      response-optional-property-removed

    • ●

      removed the optional property success from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property success from the response with the 500 status

      response-optional-property-removed

    • ○

      added the optional property code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property http_status_code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property http_status_code to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 500 status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bc91c95fbb1a1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog