quoteChargeFreeMonthsCreate

Add free months to a quote charge. The quoteChargeFreeMonthsCreate mutation in Bunny's GraphQL API, with its input attributes, return type and an example request.

Scope required: standard:write

mutation quoteChargeFreeMonthsCreate ($quoteChangeId: ID!, $freeMonths: Int!, $priceListChargeId: ID, $subscriptionChargeId: ID, $name: String, $freeMonthsAdd: Boolean) {
  quoteChargeFreeMonthsCreate (quoteChangeId: $quoteChangeId, freeMonths: $freeMonths, priceListChargeId: $priceListChargeId, subscriptionChargeId: $subscriptionChargeId, name: $name, freeMonthsAdd: $freeMonthsAdd) {
      errors
      quote {
        acceptedAt
        acceptedByName
        acceptedByTitle
        accountId
        amount
        amountAsCurrency
        amountDue
        applicationDate
        applied
        applyOnAccept
        backdatedPeriods
        backdatedQuote
        billingDay
        contactId
        createdAt
        credits
        currencyId
        customFieldsData
        dealId
        discount
        discountValue
        documentTemplateId
        emailBody
        emailSubject
        endDate
        evergreen
        expiresAt
        hasCustomFields
        id
        invoiceImmediately
        invoiceImmediatelyAvailable
        invoiceUntil
        isPendingApprovalRequest
        message
        name
        netPaymentDays
        notes
        number
        ownerId
        payToAccept
        payableId
        periodAmount
        poNumber
        requiresApproval
        sharedAt
        signingIntegration
        skipBackdatedInvoices
        smallUnitAmountDue
        splitInvoice
        startDate
        subtotal
        taxAmount
        taxCode
        taxOutOfDate
        taxationEnabled
        updatedAt
        userEmailBody
        userEmailSubject
        uuid
        viewedAt
      }
      quoteChange {
        accountId
        calculatedAdjustmentAmount
        calculatedAdjustmentPercentage
        currencyId
        endDate
        evergreen
        id
        isTrial
        name
        priceAdjustmentAllowed
        priceAdjustmentLastDate
        priceAdjustmentPercentage
        priceListId
        quoteId
        quotePlanId
        rampIntervalMonths
        renewalSummary
        renewalTermMonths
        startDate
        subscriptionId
        tenantId
        trialEndDate
        trialLengthDays
        trialStartDate
      }
      quoteCharge {
        amount
        couponId
        createdAt
        creditValidityMonths
        currencyId
        currentPrice
        currentQuantity
        discount
        endDate
        evergreen
        id
        invoiceLineText
        isRamp
        isTrial
        name
        price
        priceDecimals
        priceListChargeId
        prorationRate
        quantity
        quantityMax
        quantityMin
        quoteChangeId
        startDate
        subtotal
        taxAmount
        taxCode
        tieredAveragePrice
        topUpChargeId
        topUpMaxPerMonth
        topUpQuantity
        topUpTarget
        topUpThreshold
        updatedAt
        usageCredits
        vatCode
      }
  }
}

ArgumentsLink to Arguments section

{
  "quoteChangeId": "456123",
  "freeMonths": 123,
  "priceListChargeId": "456123",
  "subscriptionChargeId": "456123",
  "name": "",
  "freeMonthsAdd": true
}
Name Type Description
quoteChangeId ID  
freeMonths Int  
priceListChargeId ID  
subscriptionChargeId ID  
name String  
freeMonthsAdd Boolean  

ResponseLink to Response section

Name Type Description
errors List (String)  
quote Quote  
quoteChange QuoteChange  
quoteCharge QuoteCharge