GET/v1/customers/{external_id}/pricing

Get a customer's pricing

Returns the pricing sheet for a customer's track and market, with their current prices, discounts and next charges. Use me for a customer credential's own customer. Needs catalogue:read, entitlements:read or billing:self.

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

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string	The customer's external ID, or `me` for the customer a customer token or identity token names.

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string

Responses

`200`The GetCustomerPricingResponse message.

GetCustomerPricingResponse

pricesCustomerPrices
- marketPricingMarket
  - currencystringrequired
  - idstringrequired
  - keystringrequired
  - namestringrequired
  - taxMarketTaxrequired
    One of MARKET_TAX_UNSPECIFIED, MARKET_TAX_INCLUDED, MARKET_TAX_ADDED.
- subscriptionsarray of SubscriptionPricerequired
  - 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
pricingPricingSheet
- customerstring
- marketPricingMarket
  - currencystringrequired
  - idstringrequired
  - keystringrequired
  - namestringrequired
  - taxMarketTaxrequired
    One of MARKET_TAX_UNSPECIFIED, MARKET_TAX_INCLUDED, MARKET_TAX_ADDED.
- plansarray of PricedPlanrequired
  - availableOnarray of stringrequired
  - byDefaultbooleanrequired
  - descriptionstringrequired
  - feesarray of PricedFeerequired
    - directionFeeDirectionrequired
      One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.
    - keystringrequired
    - namestringrequired
    - priceAmount
      - amountintegerrequired
        at least 0; at most 18446744073709552000
      - currencystringrequired
      - displaystringrequired
    - scheduleFeeSchedule
      - everyMonthsEveryMonths
        firstAfterMonthsinteger (int64)required
        at least 0; at most 4294967295
        monthsinteger (int64)required
        at least 0; at most 4294967295
      - onPurchaseOnPurchase
      - yearlyOnYearlyOn
        datesarray of YearlyDaterequired
        dayinteger (int64)required
        at least 0; at most 4294967295
        monthinteger (int64)required
        at least 0; at most 4294967295
  - idstringrequired
  - itemsarray of PlanItemrequired
    - bankcommon.Limit
      - countinteger
        at least 0; at most 18446744073709552000
      - unlimitedcommon.Unlimited
    - benefitThousandthsinteger (int64)
      at least 0; at most 4294967295
    - featureKeystringrequired
    - homeZonestring
    - hourscommon.AccessHours
      - calendarKeystring
      - rulesarray of common.HoursRulerequired
        daysarray of common.DayClassrequired
        fromMinuteinteger (int64)required
        at least 0; at most 4294967295
        toMinuteinteger (int64)required
        at least 0; at most 4294967295
    - innerValuecommon.Limit
      - countinteger
        at least 0; at most 18446744073709552000
      - unlimitedcommon.Unlimited
    - memberValuecommon.Limit
      - countinteger
        at least 0; at most 18446744073709552000
      - unlimitedcommon.Unlimited
    - perUsecommon.Limit
      - countinteger
        at least 0; at most 18446744073709552000
      - unlimitedcommon.Unlimited
    - segmentKeystring
    - sharedMemberValuecommon.FeatureValue
      - groupcommon.GroupValue
        membersarray of common.GroupMemberrequired
        benefitThousandthsinteger (int64)
        at least 0; at most 4294967295
        featureKeystringrequired
        groupcommon.GroupValue
        meteredcommon.Limit
        moneycommon.MarketLimits
        settingcommon.SettingValue
        switchboolean
        waitcommon.Wait
      - meteredcommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
      - moneycommon.MarketLimits
        limitsarray of common.MarketLimitrequired
        limitcommon.Limit
        marketIdstringrequired
      - settingcommon.SettingValue
        choicestring
        numbercommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
        textstring
      - switchboolean
    - sharedValuecommon.FeatureValue
      - groupcommon.GroupValue
        membersarray of common.GroupMemberrequired
        benefitThousandthsinteger (int64)
        at least 0; at most 4294967295
        featureKeystringrequired
        groupcommon.GroupValue
        meteredcommon.Limit
        moneycommon.MarketLimits
        settingcommon.SettingValue
        switchboolean
        waitcommon.Wait
      - meteredcommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
      - moneycommon.MarketLimits
        limitsarray of common.MarketLimitrequired
        limitcommon.Limit
        marketIdstringrequired
      - settingcommon.SettingValue
        choicestring
        numbercommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
        textstring
      - switchboolean
    - uncountedZonesarray of stringrequired
    - valuecommon.FeatureValue
      - groupcommon.GroupValue
        membersarray of common.GroupMemberrequired
        benefitThousandthsinteger (int64)
        at least 0; at most 4294967295
        featureKeystringrequired
        groupcommon.GroupValue
        meteredcommon.Limit
        moneycommon.MarketLimits
        settingcommon.SettingValue
        switchboolean
        waitcommon.Wait
      - meteredcommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
      - moneycommon.MarketLimits
        limitsarray of common.MarketLimitrequired
        limitcommon.Limit
        marketIdstringrequired
      - settingcommon.SettingValue
        choicestring
        numbercommon.Limit
        countinteger
        at least 0; at most 18446744073709552000
        unlimitedcommon.Unlimited
        textstring
      - switchboolean
    - waitcommon.Wait
      - countinteger (int64)required
        at least 0; at most 4294967295
      - unitcommon.WaitUnitrequired
        One of WAIT_UNIT_UNSPECIFIED, WAIT_UNIT_DAYS, WAIT_UNIT_MONTHS.
  - keystringrequired
  - kindPlanKindrequired
    One of PLAN_KIND_UNSPECIFIED, PLAN_KIND_PLAN, PLAN_KIND_ADD_ON.
  - listingsarray of PlanListingrequired
    - channelsarray of PricedChannelrequired
      - connectionIdstringrequired
      - idsListingIds
        appleAppleListingIds
        productIdstringrequired
        subscriptionGroupIdstring
        googleGoogleListingIds
        basePlanIdstring
        offerIdstring
        productIdstringrequired
        purchaseOptionIdstring
        stripeStripeListingIds
        priceIdstringrequired
      - marketIdstring
      - modeConnectionModerequired
        One of CONNECTION_MODE_UNSPECIFIED, CONNECTION_MODE_LIVE, CONNECTION_MODE_TEST.
      - namestringrequired
      - priceListingPrice
        amountintegerrequired
        at least 0; at most 18446744073709552000
        currencystringrequired
        intervalListingPriceIntervalrequired
        One of LISTING_PRICE_INTERVAL_UNSPECIFIED, LISTING_PRICE_INTERVAL_DAY, LISTING_PRICE_INTERVAL_WEEK, LISTING_PRICE_INTERVAL_MONTH, LISTING_PRICE_INTERVAL_YEAR.
        intervalCountinteger (int64)required
        at least 0; at most 4294967295
        taxListingTaxBehaviourrequired
        One of LISTING_TAX_BEHAVIOUR_UNSPECIFIED, LISTING_TAX_BEHAVIOUR_INCLUSIVE, LISTING_TAX_BEHAVIOUR_EXCLUSIVE.
      - providerPaymentProviderrequired
        One of PAYMENT_PROVIDER_UNSPECIFIED, PAYMENT_PROVIDER_STRIPE, PAYMENT_PROVIDER_APPLE, PAYMENT_PROVIDER_GOOGLE.
      - purchasablebooleanrequired
    - periodIdstring
  - namestringrequired
  - packbooleanrequired
  - periodsarray of PricedPeriodrequired
    - countinteger (int64)required
      at least 0; at most 4294967295
    - idstringrequired
    - keystringrequired
    - labelstringrequired
    - unitPeriodUnitrequired
      One of PERIOD_UNIT_UNSPECIFIED, PERIOD_UNIT_DAYS, PERIOD_UNIT_WEEKS, PERIOD_UNIT_MONTHS.
  - priceStatePlanPriceStaterequired
    One of PLAN_PRICE_STATE_UNSPECIFIED, PLAN_PRICE_STATE_FREE, PLAN_PRICE_STATE_PRICED, PLAN_PRICE_STATE_NOT_PRICED.
  - pricesarray of PeriodPricerequired
    - bandsarray of PricedBandrequired
      - amountAmount
        amountintegerrequired
        at least 0; at most 18446744073709552000
        currencystringrequired
        displaystringrequired
      - perUnitbooleanrequired
      - upTointeger (int64)
        at least 0; at most 4294967295
    - periodIdstring
    - priceAmount
      - amountintegerrequired
        at least 0; at most 18446744073709552000
      - currencystringrequired
      - displaystringrequired
  - productIdstring
  - quantityQuantityRule
    - maxinteger (int64)
      at least 0; at most 4294967295
    - mininteger (int64)required
      at least 0; at most 4294967295
  - salesLedbooleanrequired
  - 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
  - statusPlanStatusrequired
    One of PLAN_STATUS_UNSPECIFIED, PLAN_STATUS_ACTIVE, PLAN_STATUS_LEGACY, PLAN_STATUS_ARCHIVED.
  - trialTrialLength
    - daysinteger (int64)
      at least 0; at most 4294967295
    - monthsinteger (int64)
      at least 0; at most 4294967295
  - usagePricesarray of PricedUsagePricerequired
    - cellsPricedUsageCells
      - bySeasonbooleanrequired
      - bySlotbooleanrequired
      - cellsarray of PricedUsageCellrequired
        rateUnitRate
        currencystringrequired
        displaystringrequired
        millionthsintegerrequired
        at least 0; at most 18446744073709552000
        seasonstring
        slotstring
    - 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
        currencystringrequired
        displaystringrequired
        millionthsintegerrequired
        at least 0; at most 18446744073709552000
    - namestringrequired
    - offsetsarray of stringrequired
    - segmentKeystring
    - tiersPricedUsageTiers
      - tiersarray of PricedUsageTierrequired
        perDayUsageDayBounds
        boundsarray of UsageDayBoundrequired
        rateUnitRate
        currencystringrequired
        displaystringrequired
        millionthsintegerrequired
        at least 0; at most 18446744073709552000
        upTointeger
        at least 0; at most 18446744073709552000
  - versionNumberintegerrequired
    at least 0; at most 18446744073709552000
- productsarray of PricedProductrequired
  - defaultPlanIdstring
  - idstringrequired
  - keystringrequired
  - namestringrequired
- servedServedCatalogue
  - changeIdstring
  - nothingNothingServed
  - releaseServedRelease
    - idstringrequired
    - numberintegerrequired
      at least 0; at most 18446744073709552000
  - trackServedTrack
    - idstringrequired
    - namestringrequired
- testersbooleanrequired

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired