PriceListCharge
The PriceListCharge type in Bunny's GraphQL API and its fields.
| Name | Type | Description |
|---|---|---|
| accountingCode | String | |
| avalaraAfcSaleType | String | |
| avalaraAfcServiceType | String | |
| avalaraAfcTransactionType | String | |
| basePrice | Float | Flat price or price of first tier if tiered or volume pricing |
| billingPeriod | BillingPeriod | |
| chargeType | ChargeType | |
| code | String | |
| createdAt | ISO8601DateTime | |
| creditKind | CreditKind | One-time and recurring charges: none, unit credits for the feature, or a currency balance. Null on usage charges |
| creditValidityMonths | Int | How long the credits a one-time credit charge grants stay usable |
| currency | Currency | |
| currencyId | ID | The currency of the price: its own on a product charge, else the price list’s |
| defaultQuantity | Int | The quantity a one-time charge is quoted at by default |
| depletionPolicy | CreditDepletionPolicy | |
| deprecated | Boolean | Whether the price list charge is deprecated |
| feature | Feature | |
| featureAddon | Boolean | True if the charge is a feature add-on |
| featureId | ID | |
| financialAccount | FinancialAccount | |
| financialAccountId | ID | |
| hidePeriodsOnInvoice | Boolean | Controls whether to hide billing periods on invoices |
| id | ID | |
| isTelecomCharge | Boolean | |
| longName | String | |
| name | String | |
| plan | Plan | |
| position | Int | |
| price | BigDecimal | |
| priceDecimals | Int | |
| priceDescription | String | One-line summary of pricing before discounts |
| priceList | PriceList | |
| priceListChargeTiers | List (PriceListChargeTier) | |
| priceListId | ID | Empty for a one-time charge sold directly on its product |
| pricingModel | PricingModel | |
| product | Product | |
| productId | ID | |
| quantityMax | Int | |
| quantityMin | Int | |
| recognitionPeriod | Int | |
| removeOnRenewal | Boolean | Whether the price list charge should be removed on renewal once it has been deprecated |
| roundUpInterval | Int | |
| selfServiceQuantity | Boolean | |
| showPriceAsMonthly | Boolean | |
| specificInvoiceLineText | String | |
| taxCode | String | |
| topUp | Boolean | True for the one-time credit charge a usage charge’s auto top-up buys. It is never added to a quote by default |
| topUpCharge | PriceListCharge | |
| topUpChargeId | ID | Credits-mode usage with a top-up policy: the top-up charge each top-up buys |
| topUpMaxPerMonth | Int | Most top-ups per month; empty means no cap |
| topUpQuantity | BigDecimal | Credits each top-up buys |
| topUpTarget | BigDecimal | Top up to this many available credits |
| topUpThreshold | BigDecimal | Top up when available credits drop to or below this |
| topUpUsageCharge | PriceListCharge | The usage charge whose auto top-up buys this charge |
| unitLabel | String | The unit a product charge is sold in, e.g. “day” |
| unitPricing | UnitPricing | How a product charge is priced on a line; null on price list charges |
| updatedAt | ISO8601DateTime | |
| usageCalculationType | UsageCalculation | Describes how usage should be aggregated during a billing period. Must be one of sum, max, last, average |
| usageCredits | Boolean | True when the charge grants credits |
| usageMode | UsageMode | Usage charges: postpaid, or drawn from credits as usage arrives |