Skip to content
EntitlerDocs

GET/v1/customers/{external_id}/offers

List offers available to a customer

Lists the offers the customer can take, with their price before and after. productId is optional. Needs customers:read or billing:self.

curl 'https://api.entitler.co/v1/customers/ada/offers' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstringThe customer's external ID, or me for the customer a customer token or identity token names.

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring
product_idstring

Responses

200The ListAvailableOffersResponse message.

ListAvailableOffersResponse

  • asOfintegerrequired

    at least 0; at most 18446744073709552000

  • offersarray of AvailableOfferrequired
    • afterSubscriptionPrice
      • atRenewalCustomerPriceLines
        • linesarray of CustomerPriceLinerequired
          • bandCustomerLineBand
            • flatbooleanrequired
            • upTointeger (int64)

              at least 0; at most 4294967295

          • discountsarray of CustomerLineDiscountrequired
            • amountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
            • offerIdstringrequired
            • offerKeystringrequired
            • offerNamestringrequired
          • listPriceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • periodIdstring
          • planIdstringrequired
          • priceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • quantityinteger (int64)required

            at least 0; at most 4294967295

          • statePlanPriceStaterequired

            One of PLAN_PRICE_STATE_UNSPECIFIED, PLAN_PRICE_STATE_FREE, PLAN_PRICE_STATE_PRICED, PLAN_PRICE_STATE_NOT_PRICED.

          • unitPriceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • versionintegerrequired

            at least 0; at most 18446744073709552000

      • nextChargesarray of NextChargerequired
        • amountAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • atintegerrequired

          at least 0; at most 18446744073709552000

        • directionFeeDirectionrequired

          One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

        • feeKeystringrequired
      • nowarray of CustomerPriceLinerequired
        • bandCustomerLineBand
          • flatbooleanrequired
          • upTointeger (int64)

            at least 0; at most 4294967295

        • discountsarray of CustomerLineDiscountrequired
          • amountAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • offerIdstringrequired
          • offerKeystringrequired
          • offerNamestringrequired
        • listPriceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • periodIdstring
        • planIdstringrequired
        • priceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • quantityinteger (int64)required

          at least 0; at most 4294967295

        • statePlanPriceStaterequired

          One of PLAN_PRICE_STATE_UNSPECIFIED, PLAN_PRICE_STATE_FREE, PLAN_PRICE_STATE_PRICED, PLAN_PRICE_STATE_NOT_PRICED.

        • unitPriceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • versionintegerrequired

          at least 0; at most 18446744073709552000

      • productIdstring
      • renewsAtintegerrequired

        at least 0; at most 18446744073709552000

      • subscriptionIdstringrequired
      • usageSubscriptionUsage
        • estimatesarray of UsageEstimaterequired
          • chargesarray of EstimatedUsageChargerequired
            • amountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
            • directionFeeDirectionrequired

              One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

            • linesarray of UsageChargeLinerequired
              • amountAmount
              • decimalsinteger (int64)

                at least 0; at most 4294967295

              • featureKeystring
              • listAmountAmount
              • offsetAmount
              • planIdstringrequired
              • quantityintegerrequired

                at least 0; at most 18446744073709552000

              • usagePeriodChargeUsagePeriod
              • usagePriceKeystringrequired
              • versionintegerrequired

                at least 0; at most 18446744073709552000

            • listAmountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
          • featureKeystring
          • usagePeriodChargeUsagePeriod
            • endsAtintegerrequired

              at least 0; at most 18446744073709552000

            • startsAtintegerrequired

              at least 0; at most 18446744073709552000

        • versionsarray of SubscriptionUsageVersionrequired
          • planIdstringrequired
          • pricesarray of CustomerUsagePricerequired
            • cellsPricedUsageCells
              • bySeasonbooleanrequired
              • bySlotbooleanrequired
              • cellsarray of PricedUsageCellrequired
            • classstring
            • directionFeeDirectionrequired

              One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

            • featureKeystring
            • flatUnitRate
              • currencystringrequired
              • displaystringrequired
              • millionthsintegerrequired

                at least 0; at most 18446744073709552000

            • fromUsageFromrequired

              One of USAGE_FROM_UNSPECIFIED, USAGE_FROM_ALL, USAGE_FROM_OVER_ALLOWANCE.

            • keystringrequired
            • minimumPricedUsageMinimum
              • perMinimumPerrequired

                One of MINIMUM_PER_UNSPECIFIED, MINIMUM_PER_DAY, MINIMUM_PER_PERIOD.

              • rateUnitRate
            • offsetsarray of stringrequired
            • tiersPricedUsageTiers
              • tiersarray of PricedUsageTierrequired
          • seasonsarray of SeasonStartrequired
            • dayinteger (int64)required

              at least 0; at most 4294967295

            • monthinteger (int64)required

              at least 0; at most 4294967295

            • seasonstringrequired
          • slotsarray of PlanSlotrequired
            • hoursarray of SlotHoursrequired
              • daysSlotDaysrequired

                One of SLOT_DAYS_UNSPECIFIED, SLOT_DAYS_EVERY_DAY, SLOT_DAYS_WEEKDAYS, SLOT_DAYS_WEEKENDS.

              • frominteger (int64)required

                at least 0; at most 4294967295

              • tointeger (int64)required

                at least 0; at most 4294967295

            • keystringrequired
          • versionintegerrequired

            at least 0; at most 18446744073709552000

    • beforeSubscriptionPrice
      • atRenewalCustomerPriceLines
        • linesarray of CustomerPriceLinerequired
          • bandCustomerLineBand
            • flatbooleanrequired
            • upTointeger (int64)

              at least 0; at most 4294967295

          • discountsarray of CustomerLineDiscountrequired
            • amountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
            • offerIdstringrequired
            • offerKeystringrequired
            • offerNamestringrequired
          • listPriceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • periodIdstring
          • planIdstringrequired
          • priceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • quantityinteger (int64)required

            at least 0; at most 4294967295

          • statePlanPriceStaterequired

            One of PLAN_PRICE_STATE_UNSPECIFIED, PLAN_PRICE_STATE_FREE, PLAN_PRICE_STATE_PRICED, PLAN_PRICE_STATE_NOT_PRICED.

          • unitPriceAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • versionintegerrequired

            at least 0; at most 18446744073709552000

      • nextChargesarray of NextChargerequired
        • amountAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • atintegerrequired

          at least 0; at most 18446744073709552000

        • directionFeeDirectionrequired

          One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

        • feeKeystringrequired
      • nowarray of CustomerPriceLinerequired
        • bandCustomerLineBand
          • flatbooleanrequired
          • upTointeger (int64)

            at least 0; at most 4294967295

        • discountsarray of CustomerLineDiscountrequired
          • amountAmount
            • amountintegerrequired

              at least 0; at most 18446744073709552000

            • currencystringrequired
            • displaystringrequired
          • offerIdstringrequired
          • offerKeystringrequired
          • offerNamestringrequired
        • listPriceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • periodIdstring
        • planIdstringrequired
        • priceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • quantityinteger (int64)required

          at least 0; at most 4294967295

        • statePlanPriceStaterequired

          One of PLAN_PRICE_STATE_UNSPECIFIED, PLAN_PRICE_STATE_FREE, PLAN_PRICE_STATE_PRICED, PLAN_PRICE_STATE_NOT_PRICED.

        • unitPriceAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • versionintegerrequired

          at least 0; at most 18446744073709552000

      • productIdstring
      • renewsAtintegerrequired

        at least 0; at most 18446744073709552000

      • subscriptionIdstringrequired
      • usageSubscriptionUsage
        • estimatesarray of UsageEstimaterequired
          • chargesarray of EstimatedUsageChargerequired
            • amountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
            • directionFeeDirectionrequired

              One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

            • linesarray of UsageChargeLinerequired
              • amountAmount
              • decimalsinteger (int64)

                at least 0; at most 4294967295

              • featureKeystring
              • listAmountAmount
              • offsetAmount
              • planIdstringrequired
              • quantityintegerrequired

                at least 0; at most 18446744073709552000

              • usagePeriodChargeUsagePeriod
              • usagePriceKeystringrequired
              • versionintegerrequired

                at least 0; at most 18446744073709552000

            • listAmountAmount
              • amountintegerrequired

                at least 0; at most 18446744073709552000

              • currencystringrequired
              • displaystringrequired
          • featureKeystring
          • usagePeriodChargeUsagePeriod
            • endsAtintegerrequired

              at least 0; at most 18446744073709552000

            • startsAtintegerrequired

              at least 0; at most 18446744073709552000

        • versionsarray of SubscriptionUsageVersionrequired
          • planIdstringrequired
          • pricesarray of CustomerUsagePricerequired
            • cellsPricedUsageCells
              • bySeasonbooleanrequired
              • bySlotbooleanrequired
              • cellsarray of PricedUsageCellrequired
            • classstring
            • directionFeeDirectionrequired

              One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.

            • featureKeystring
            • flatUnitRate
              • currencystringrequired
              • displaystringrequired
              • millionthsintegerrequired

                at least 0; at most 18446744073709552000

            • fromUsageFromrequired

              One of USAGE_FROM_UNSPECIFIED, USAGE_FROM_ALL, USAGE_FROM_OVER_ALLOWANCE.

            • keystringrequired
            • minimumPricedUsageMinimum
              • perMinimumPerrequired

                One of MINIMUM_PER_UNSPECIFIED, MINIMUM_PER_DAY, MINIMUM_PER_PERIOD.

              • rateUnitRate
            • offsetsarray of stringrequired
            • tiersPricedUsageTiers
              • tiersarray of PricedUsageTierrequired
          • seasonsarray of SeasonStartrequired
            • dayinteger (int64)required

              at least 0; at most 4294967295

            • monthinteger (int64)required

              at least 0; at most 4294967295

            • seasonstringrequired
          • slotsarray of PlanSlotrequired
            • hoursarray of SlotHoursrequired
              • daysSlotDaysrequired

                One of SLOT_DAYS_UNSPECIFIED, SLOT_DAYS_EVERY_DAY, SLOT_DAYS_WEEKDAYS, SLOT_DAYS_WEEKENDS.

              • frominteger (int64)required

                at least 0; at most 4294967295

              • tointeger (int64)required

                at least 0; at most 4294967295

            • keystringrequired
          • versionintegerrequired

            at least 0; at most 18446744073709552000

    • offerIdstringrequired
    • offerKeystringrequired
    • offerNamestringrequired
    • periodIdstring
    • planIdstring
  • truncatedbooleanrequired

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired