Skip to main content
POST
Search Consumer Offer

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Consumer offer search criteria.

consumer
ConsumerBase · object
required

Filter search by this consumer.

status
enum<string>

Filter search by this consumer offer status.

  • FULLY_CREATED: all entitlements have been created
  • FULLY_ACTIVE: all entitlements are active
  • FULLY_TERMINATED: all entitlements have been terminated
Available options:
FULLY_CREATED,
FULLY_ACTIVE,
FULLY_TERMINATED

Response

Ok

consumerOffer
ConsumerOfferDetail · object
required

Consumer offer detail

entitlements
Entitlement · object[]
required

Entitlements created under this consumer offer.