Create plan credit grant

Which boundary closes a monthly arrears window: the subscription’s own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start.

How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. Quarterly is not available for postpaid charges.

Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed). Billed is only available on custom plans. Defaults to granted.

Credits granted once per company on top of the per-license amount. Only valid when scaling is per_license. Defaults to 0.

The license whose quantity scales this grant. Required when scaling is per_license.

Optional limit on how far the balance may go below zero, in credits. It is a floor on the balance rather than an allowance per invoice window: the balance may run down to minus this figure, and beyond it the flag check denies the same way an exhausted balance does with postpaid off. Nothing resets when an invoice window rolls, so a company that reaches the limit stays denied until a new grant lands or the negative balance is settled. Omit for no limit.

Whether consumption may continue past a zero balance. When false (the default) the flag check denies once the balance is exhausted, which is the existing behavior. When true, consumption continues and accrues at postpaid_rate_per_unit, settled on arrears_cadence. Intended for invoice-billed customers on net terms, who have no card for auto top-up to charge.

Amount charged per credit consumed past a zero balance, in the currency’s minor unit. Optional: defaults to the credit’s own cost basis (price_per_unit) when postpaid_enabled is true.

Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit’s own price_per_unit_decimal behaves.

Tier table pricing the credits on this grant, cheapest bound first, the last tier unbounded. Give this instead of unit_price to charge a rate that changes with the number of credits on the invoice. Requires tier_mode.

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.

How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier’s own credits at its own rate. Required with price_tiers.

Price per credit in the plan currency’s smallest unit. Required when billing_mode is billed, unless unit_price_decimal or price_tiers is set.

Deprecated: use compatible_plan_ids on credit bundles instead. Still accepted; writes through to the credit’s bundle compatibility.