priceListAmountDuePreview

Amount due for signing up to a price list, before an account exists. The priceListAmountDuePreview mutation in Bunny's GraphQL API, with its input attributes, return type and an example request.

Scope required: standard:write

mutation priceListAmountDuePreview ($priceListCode: String!, $billingDetails: BillingDetailsAttributes, $couponCode: String, $trial: Boolean) {
  priceListAmountDuePreview (priceListCode: $priceListCode, billingDetails: $billingDetails, couponCode: $couponCode, trial: $trial) {
      amountDue
      currencyId
      discountAmount
      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
        taxationEnabled
        updatedAt
        userEmailBody
        userEmailSubject
        uuid
        viewedAt
      }
      subtotal
      taxAmount
      taxesCalculated
  }
}

Arguments

{
  "priceListCode": "",
  "billingDetails": {
    "billingStreet": "",
    "billingCity": "",
    "billingState": "",
    "billingZip": "",
    "billingCountry": "",
    "billingContactEmail": "",
    "taxNumber": ""
  },
  "couponCode": "",
  "trial": true
}
Name Type Description
priceListCode String  
billingDetails BillingDetailsAttributes  
couponCode String  
trial Boolean  

Response

Name Type Description
amountDue Float  
currencyId String  
discountAmount Float  
errors List (String)  
quote Quote  
subtotal Float  
taxAmount Float  
taxesCalculated Boolean