SCschematichq
credits

Update credit bundle details

Changed on
put/billing/credits/bundles/{bundle_id}

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/billing/credits/bundles/{bundle_id}
  • Auth
    API key in header X-Schematic-Api-Key

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

  • 3a5380b4b7edRevision changes
    • breaking

      the request property's maxLength was decreased to 255

  • d1e247b0a256Revision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status