PriceListChargeAttributes

The PriceListChargeAttributes input type in Bunny's GraphQL API, with its fields and an example.

{
  "id": "456123",
  "priceListId": "456123",
  "productId": "456123",
  "currencyId": "456123",
  "name": "",
  "code": "",
  "selfServiceQuantity": true,
  "specificInvoiceLineText": "",
  "pricingModel": "PricingModel",
  "chargeType": "ChargeType",
  "billingPeriod": "BillingPeriod",
  "showPriceAsMonthly": true,
  "accountingCode": "",
  "taxCode": "",
  "quantityMin": 123,
  "quantityMax": 123,
  "defaultQuantity": 123,
  "roundUpInterval": 123,
  "price": "BigDecimal",
  "priceDecimals": 123,
  "position": 123,
  "featureId": "456123",
  "featureCode": "",
  "featureAddon": true,
  "usageCalculationType": "UsageCalculation",
  "recognitionPeriod": 123,
  "unitLabel": "",
  "unitPricing": "UnitPricing",
  "financialAccountId": "456123",
  "isTelecomCharge": true,
  "avalaraAfcTransactionType": "",
  "avalaraAfcServiceType": "",
  "avalaraAfcSaleType": "",
  "hidePeriodsOnInvoice": true,
  "creditKind": "CreditKind",
  "usageCredits": true,
  "creditValidityMonths": 123,
  "depletionPolicy": "CreditDepletionPolicy",
  "topUpThreshold": "BigDecimal",
  "topUpQuantity": "BigDecimal",
  "topUpTarget": "BigDecimal",
  "topUpMaxPerMonth": 123,
  "usageMode": "UsageMode",
  "priceListChargeTiers": [
    {
      "starts": 123,
      "price": "BigDecimal"
    }
  ]
}
Name Type Description
id ID  
priceListId ID  
productId ID Create only: puts a one-time charge directly on the product, in place of priceListId
currencyId ID Create only, with productId: the currency of the product charge (ISO code)
name String  
code String  
selfServiceQuantity Boolean  
specificInvoiceLineText String  
pricingModel PricingModel  
chargeType ChargeType  
billingPeriod BillingPeriod  
showPriceAsMonthly Boolean  
accountingCode String  
taxCode String  
quantityMin Int  
quantityMax Int  
defaultQuantity Int The quantity a one-time charge is quoted at by default
roundUpInterval Int  
price BigDecimal  
priceDecimals Int  
position Int  
featureId ID  
featureCode String  
featureAddon Boolean  
usageCalculationType UsageCalculation  
recognitionPeriod Int  
unitLabel String Product charges only: the unit sold, e.g. “day”. Blank sells once per line
unitPricing UnitPricing Product charges only: FLAT clears unitLabel, PER_UNIT requires one
financialAccountId ID  
isTelecomCharge Boolean  
avalaraAfcTransactionType String  
avalaraAfcServiceType String  
avalaraAfcSaleType String  
hidePeriodsOnInvoice Boolean Controls whether to hide billing periods on invoices
creditKind CreditKind Sets usageCredits, and clears the feature for a balance
usageCredits Boolean The charge grants credits: units of its feature, or a dollar balance without one
creditValidityMonths Int How long the credits a one-time credit charge grants stay usable
depletionPolicy CreditDepletionPolicy Credits-mode usage: what happens when credits run out; empty means overage. TOP_UP creates the top-up charge on the price list if it has none
topUpThreshold BigDecimal Top up when available credits drop to or below this
topUpQuantity BigDecimal Credits each top-up buys; or give a top-up target
topUpTarget BigDecimal Top up to this many available credits; or give a top-up quantity
topUpMaxPerMonth Int Most top-ups per month; empty means no cap
usageMode UsageMode Usage charges only: bill aggregated usage in arrears, or draw credits as usage arrives
priceListChargeTiers List (PriceListChargeTierAttributes)