FLflexprice
Contracts

Query contracts

Changed on

Use when searching revenue recognition contracts by customer, subscription or contract status. Returns a paginated list.

post/contracts/search

Request

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

Request body

contract_idsstring[]
contract_statusesTypesContractStatus[]
customer_idsstring[]
end_timestring date-time
ended_at_gtestring date-time
expandstring
limitinteger
offsetinteger
order'asc' | 'desc'
start_timestring date-time
status'published' | 'deleted' | 'archived'
subscription_idsstring[]

Response

OK

Changes

  • d3bef0889eecRevision changes
    • info

      added the new optional request property

  • f4730fdf8ea5Revision changes
    • warning

      added the new credit_note enum value to the //// response property for the response status

    • warning

      added the new invoice enum value to the //// response property for the response status

    • warning

      added the new payment enum value to the //// response property for the response status

    • warning

      added the new pob enum value to the //// response property for the response status

    • warning

      added the new refund enum value to the //// response property for the response status