quoteChargeFreeMonthsCreate

Graphql fields and variables for the quoteChargeFreeMonthsCreate mutation

Add free months to a quote charge

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 {
        acceptedByName
        acceptedByTitle
        accountId
        amount
        amountDue
        applicationDate
        applied
        applyOnAccept
        backdatedPeriods
        backdatedQuote
        billingDay
        contactId
        createdAt
        credits
        currencyId
        dealId
        discount
        discountValue
        documentTemplateId
        endDate
        evergreen
        expiresAt
        id
        invoiceImmediately
        invoiceImmediatelyAvailable
        invoiceUntil
        isPendingApprovalRequest
        message
        name
        netPaymentDays
        notes
        number
        ownerId
        payToAccept
        payableId
        periodAmount
        poNumber
        requiresApproval
        smallUnitAmountDue
        splitInvoice
        startDate
        subtotal
        taxAmount
        taxCode
        updatedAt
        uuid
      }
      quoteChange {
        currencyId
        endDate
        evergreen
        id
        name
        priceAdjustmentAllowed
        priceAdjustmentLastDate
        priceAdjustmentPercentage
        priceListId
        quoteId
        quotePlanId
        rampIntervalMonths
        renewalSummary
        renewalTermMonths
        startDate
        subscriptionId
      }
      quoteCharge {
        amount
        couponId
        createdAt
        currencyId
        currentPrice
        currentQuantity
        discount
        endDate
        id
        invoiceLineText
        isRamp
        name
        price
        priceDecimals
        priceListChargeId
        prorationRate
        quantity
        quantityMax
        quantityMin
        quoteChangeId
        startDate
        subtotal
        taxAmount
        taxCode
        tieredAveragePrice
        updatedAt
        vatCode
      }
  }
}

Arguments

{
  "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

Response

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