plangroups

Update plan group

Changed on
put/plan-groups/{plan_group_id}

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/plan-groups/{plan_group_id}
  • Auth
    API key in header X-Schematic-Api-Key

Path parameters

plan_group_idstring required

plan_group_id

Request body

add_on_idsstring[] required

Use OrderedAddOns instead

checkout_bundle_purchase_behavior'individual' | 'quantity'
checkout_collect_addressboolean required
checkout_collect_emailboolean required
checkout_collect_phoneboolean required
checkout_collect_tax_idboolean required
custom_plan_idstring nullable
enable_tax_collectionboolean required
fallback_plan_idstring nullable
initial_plan_idstring nullable
initial_plan_price_idstring nullable
opt_in_enabledboolean required
opt_in_textstring nullable
opt_in_titlestring nullable
prevent_downgrades_when_over_limitboolean required
prevent_self_service_downgradeboolean required
prevent_self_service_downgrade_button_textstring nullable
prevent_self_service_downgrade_urlstring nullable
proration_behavior'create_prorations' | 'invoice_immediately' required
scheduled_downgrade_behavior'end_of_billing_period' | 'none'
scheduled_downgrade_prevent_when_over_limitboolean nullable
show_as_monthly_pricesboolean required
show_creditsboolean required
show_estimated_totalboolean required
show_feature_descriptionboolean required
show_hard_limitboolean required
show_period_toggleboolean required
show_zero_price_as_freeboolean required
sync_customer_billing_detailsboolean required
trial_daysinteger nullable
trial_eligibility_per_planboolean nullable
trial_expiry_plan_idstring nullable
trial_expiry_plan_price_idstring nullable
trial_payment_method_requiredboolean nullable

Response

OK

paramsobject required

Input parameters

Changes

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • breaking

      added the new required request property

    • info

      added the required property // to the response with the status