CLcloudblue
Offers

GET /offers/{offer_id}/plans/-/inventory

Changed on

Request

  • Base URL
    https://api.connect.cloudblue.com/public/v1
  • Auth
    API key in header Authorization

Path parameters

offer_idstring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

offer_item.idstring

Filter for: offer_item.id

lookups: eq, ne, like, ilike, null, in, out

period'days_7_trial' | 'days_14_trial' | 'monthly' | 'monthly_trial' | 'yearly' | 'years_2' | 'years_3' | 'years_4' | 'years_5' | 'years_6' | 'onetime' | 'trial'

Filter for: period

lookups: eq, ne, like, ilike, in, out

plan.idstring

Filter for: plan.id

lookups: eq, ne, like, ilike, null, in, out

Response

offer_itemstring
period'days_7_trial' | 'days_14_trial' | 'monthly' | 'monthly_trial' | 'yearly' | 'years_2' | 'years_3' | 'years_4' | 'years_5' | 'years_6' | 'onetime' | 'trial' required
planstring

Changes

  • 54fef191d46cRevision changes
    • warning

      deleted the query request parameter commitments

    • warning

      removed the optional property / from the response with the status

    • info

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

  • ed203419a9a7Revision changes
    • info

      endpoint added