credits

Update credit bundle details

put/billing/credits/bundles/{bundle_id}

Path parameters

bundle_idstring required

bundle_id

Request body

bundle_namestring required
compatible_plan_idsstring[] nullable

Plans whose companies may purchase this bundle. Omitted leaves compatibility unchanged; empty resets the bundle to purchasable on every plan.

expiry_type'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry'
expiry_unit'billing_periods' | 'days'
expiry_unit_countinteger nullable
price_per_unitinteger required
price_per_unit_decimalstring nullable
quantityinteger nullable
status'active' | 'inactive'

Response

OK

paramsobject required

Input parameters

Changes

Changed in 3 of the 125 revisions of this API.132

    • the bundle_name request property's maxLength was decreased to 255

      request-property-max-length-decreased

    • added the new optional request property compatible_plan_ids

      new-optional-request-property

    • added the required property data/compatible_plan_ids to the response with the 200 status

      response-required-property-added

    • added the new metronome enum value to the data/currency_prices/items/price/provider_type response property for the response status 200

      response-property-enum-value-added

    • added the new metronome enum value to the data/price/provider_type response property for the response status 200

      response-property-enum-value-added

    • added the new metronome enum value to the data/unit_price/provider_type response property for the response status 200

      response-property-enum-value-added