Sign in
Subscriptions

Search subscription line items

List subscription line items with a JSON filter (subscription, customer, price, pagination, expand=prices, etc.).

post/subscriptions/lineitems/search

Request body

active_filterboolean
addon_association_idsstring[]
billing_periodsstring[]
currenciesstring[]
current_period_startstring date-time
customer_idsstring[]
end_timestring date-time
entity_idsstring[]
entity_type'plan' | 'addon' | 'subscription'
expandstring
limitinteger
meter_idsstring[]
offsetinteger
order'asc' | 'desc'
price_idsstring[]
start_timestring date-time
status'published' | 'deleted' | 'archived'
subscription_idsstring[]
subscription_line_item_idsstring[]

Specific filters

Response

OK

Changes

Changed in 3 of the 12 revisions of this API.65

  • cef2964c102c24See the full diff
    • ●

      added the new config enum value to the items/items/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 items/items/price/addon/entitlements/items/feature_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property subscription_line_item_ids

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property items/items/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

  • 0cb3425d65801See the full diff
    • ○

      endpoint added

      endpoint-added

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