FLflexprice
Commitments

Query commitments

Changed on

Lists commitments with filtering and sorting. Returns a paginated list.

post/commitments/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/commitments/search
  • Auth
    API key in header x-api-key

Request body

active_fromstring

ActiveFrom/ActiveTo select commitments whose term overlaps [ActiveFrom, ActiveTo).

active_tostring
customer_idsstring[]
end_timestring date-time
expandstring
idsstring[]
limitinteger
offsetinteger
order'asc' | 'desc'
scope_entity_idsstring[]
scope_entity_type'subscription' | 'group' | 'meter' | 'price'
start_timestring date-time
status'published' | 'deleted' | 'archived'
statusesTypesCommitmentStatus[]
subscription_idsstring[]

Response

OK

Changes