entitlements

Create company override

post/company-overrides

Request body

company_idstring required
credit_consumption_ratenumber double nullable
expiration_datestring date-time nullable
feature_idstring required
metric_period'all_time' | 'current_day' | 'current_month' | 'current_week'
metric_period_month_reset'billing_cycle' | 'first_of_month'
notestring nullable
value_boolboolean nullable
value_credit_idstring nullable
value_numericinteger nullable
value_trait_idstring nullable
value_type'boolean' | 'credit' | 'numeric' | 'trait' | 'unknown' | 'unlimited' required

Response

Created

paramsobject required

Input parameters

Changes

Changed in 19 of the 125 revisions of this API.72533

    • added the optional property data/company/custom_plan_billings/items/prorate_first_period to the response with the 201 status

      response-optional-property-added

    • added the optional property data/company/pending_migration to the response with the 201 status

      response-optional-property-added

    • added the optional property data/company/custom_plan_billings/items/billing_cycle_anchor to the response with the 201 status

      response-optional-property-added

    • added the required property data/company/custom_plan_billings/items/plan_billing_source to the response with the 201 status

      response-required-property-added

    • added the required property data/company/add_ons/items/included_credit_grants/items/company_credit_amount to the response with the 201 status

      response-required-property-added

    • added the required property data/company/plan/included_credit_grants/items/company_credit_amount to the response with the 201 status

      response-required-property-added

  • 478f08b8fada642See the full diff
    • removed the required property data/company/add_ons/items/included_credit_grants/items/credit/product/price from the response with the 201 status

      response-required-property-removed

    • removed the required property data/company/add_ons/items/included_credit_grants/items/credit/product/product_id from the response with the 201 status

      response-required-property-removed

    • removed the required property data/company/add_ons/items/included_credit_grants/items/credit/product/quantity from the response with the 201 status

      response-required-property-removed

    • removed the required property data/company/plan/included_credit_grants/items/credit/product/price from the response with the 201 status

      response-required-property-removed

    • removed the required property data/company/plan/included_credit_grants/items/credit/product/product_id from the response with the 201 status

      response-required-property-removed

    • removed the required property data/company/plan/included_credit_grants/items/credit/product/quantity from the response with the 201 status

      response-required-property-removed

    • removed the optional property data/company/add_ons/items/included_credit_grants/items/credit/product/currency from the response with the 201 status

      response-optional-property-removed

    • removed the optional property data/company/add_ons/items/included_credit_grants/items/credit/product/price_decimal from the response with the 201 status

      response-optional-property-removed

    • removed the optional property data/company/plan/included_credit_grants/items/credit/product/currency from the response with the 201 status

      response-optional-property-removed

    • removed the optional property data/company/plan/included_credit_grants/items/credit/product/price_decimal from the response with the 201 status

      response-optional-property-removed

    • added the required property data/company/add_ons/items/included_credit_grants/items/credit/product/id to the response with the 201 status

      response-required-property-added

    • added the required property data/company/plan/included_credit_grants/items/credit/product/id to the response with the 201 status

      response-required-property-added

    • added the optional property data/company/add_ons/items/included_credit_grants/items/license_id to the response with the 201 status

      response-optional-property-added

    • added the optional property data/company/plan/included_credit_grants/items/license_id to the response with the 201 status

      response-optional-property-added

    • added the required property data/company/add_ons/items/included_credit_grants/items/scaling to the response with the 201 status

      response-required-property-added

    • added the required property data/company/plan/included_credit_grants/items/scaling to the response with the 201 status

      response-required-property-added

    • added the required property data/company/custom_plan_billings/items/send_invoice to the response with the 201 status

      response-required-property-added

  • e83d3358bab312See the full diff
    • added the new license enum value to the data/feature/feature_type response property for the response status 201

      response-property-enum-value-added

    • added the optional property data/feature/license_id to the response with the 201 status

      response-optional-property-added

    • added the optional property data/feature/usage_limit_trait_id to the response with the 201 status

      response-optional-property-added

    • added the optional property data/company/entitlements/items/warning_tiers to the response with the 201 status

      response-optional-property-added