Plans

Query plans

Changed on

Use when listing or searching plans (e.g. plan picker or admin catalog). Returns a paginated list; supports filtering and sorting.

post/plans/search

Request

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

Request body

end_timestring date-time
expandstring
limitinteger
lookup_keystring
metadataobject
offsetinteger
order'asc' | 'desc'
plan_idsstring[]
start_timestring date-time
status'published' | 'deleted' | 'archived'

Response

OK

Changes

  • 9cd0dab91f5cRevision changes
    • info

      added the optional property // to the response with the status

  • d567e8585c2eRevision changes
    • warning

      removed the optional property // from the response with the status