credits
Create billing plan credit grant
post/billing/credits/plan-grants
Request body
apply_to_existingboolean nullable
auto_topup_amountinteger nullable
auto_topup_amount_type'credit'
auto_topup_availability'off' | 'automatic' | 'user_controlled'
auto_topup_enabledboolean nullable
auto_topup_expiry_type'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry'
auto_topup_expiry_unit'billing_periods' | 'days'
auto_topup_expiry_unit_countinteger nullable
auto_topup_self_serviceboolean nullable
auto_topup_threshold_creditsinteger nullable
auto_topup_threshold_percentinteger nullable
can_buy_bundlesboolean nullable
credit_amountinteger required
credit_idstring 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
license_idstring nullable
The license whose quantity scales this grant. Required when scaling is per_license.
plan_idstring required
plan_version_idstring nullable
reset_cadence'daily' | 'every_6_months' | 'monthly' | 'quarterly' | 'weekly' | 'yearly' required
reset_start'billing_period' | 'first_of_month' required
reset_type'no_reset' | 'plan_period'
rollover_percentageinteger nullable
Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. Defaults to 0.
scaling'fixed' | 'per_license'
Response
Created
paramsobject required
Input parameters