credits

Create credit bundle

post/billing/credits/bundles

Request body

bundle_namestring required
bundle_type'fixed'
compatible_plan_idsstring[] nullable

Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan.

credit_idstring required
currencystring required
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

Created

paramsobject required

Input parameters

Changes

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

  • 3a5380b4b7ed11See the full diff
    • the bundle_name request property's maxLength was decreased to 255

      request-property-max-length-decreased

    • the currency request property's maxLength was set to 3

      request-property-max-length-set

    • 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 201 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 201

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added