quoteAccountSignup

Create an account, quote and payment method for a subscription and check it out. The quoteAccountSignup mutation in Bunny's GraphQL API, with its input attributes, return type and an example request.

Scope required: standard:write

mutation quoteAccountSignup ($accountName: String, $accountCode: String, $billingContact: ContactAttributes, $billingDetails: BillingDetailsAttributes, $priceListCode: String!, $quantity: Int, $trial: Boolean, $payToAccept: Boolean, $documentTemplateId: ID, $couponCode: String, $paymentMethod: SignupPaymentMethodAttributes) {
  quoteAccountSignup (accountName: $accountName, accountCode: $accountCode, billingContact: $billingContact, billingDetails: $billingDetails, priceListCode: $priceListCode, quantity: $quantity, trial: $trial, payToAccept: $payToAccept, documentTemplateId: $documentTemplateId, couponCode: $couponCode, paymentMethod: $paymentMethod) {
      account {
        accountTypeId
        addressValidated
        annualRevenue
        arr
        billingCity
        billingContactId
        billingCountry
        billingDay
        billingState
        billingStreet
        billingZip
        code
        consolidatedBilling
        createdAt
        currencyId
        currencyLocked
        customFieldsData
        description
        disableDunning
        displayName
        draftInvoices
        duns
        effectiveBillingDate
        emailsEnabled
        employees
        entityId
        entityUseCode
        fastForwarded
        fastForwarding
        fax
        forwardTo
        forwardedTo
        groupId
        hasChildAccounts
        hasCustomFields
        hasInvoicedCharges
        id
        inHierarchy
        industryId
        integrationManaged
        invoiceTemplateId
        invoicedAccountId
        linkedinUrl
        mrr
        mur
        name
        netPaymentDays
        newQuoteBuilder
        nextRenewal
        ownerUserId
        parentAccountId
        payingAccountId
        phone
        revenueToDate
        sandbox
        shippingCity
        shippingCountry
        shippingState
        shippingStreet
        shippingZip
        taxNumber
        taxNumberValidated
        timezone
        updatedAt
        website
      }
      amount
      currencyId
      errors
      portalSessionToken
      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
      }
      tenant {
        accountId
        code
        createdAt
        customFieldsData
        hasCustomFields
        id
        lastLogin
        lastSuccessfulWebhookAt
        lastWebhookStatus
        name
        platformId
        subdomain
        tenantUuid
        updatedAt
        userCount
        utilizationMetrics
      }
  }
}

ArgumentsLink to Arguments section

{
  "accountName": "",
  "accountCode": "",
  "billingContact": {
    "code": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "salutation": "",
    "title": "",
    "phone": "",
    "mobile": "",
    "mailingStreet": "",
    "mailingCity": "",
    "mailingZip": "",
    "mailingState": "",
    "mailingCountry": "",
    "portalAccess": true,
    "description": "",
    "accountId": "456123",
    "accountCode": "",
    "campaignCode": "",
    "linkedinUrl": ""
  },
  "billingDetails": {
    "billingStreet": "",
    "billingCity": "",
    "billingState": "",
    "billingZip": "",
    "billingCountry": "",
    "billingContactEmail": "",
    "taxNumber": ""
  },
  "priceListCode": "",
  "quantity": 123,
  "trial": true,
  "payToAccept": true,
  "documentTemplateId": "456123",
  "couponCode": "",
  "paymentMethod": {
    "pluginGuid": "456123",
    "token": "",
    "metadata": "JSON"
  }
}
Name Type Description
accountName String  
accountCode String  
billingContact ContactAttributes  
billingDetails BillingDetailsAttributes  
priceListCode String  
quantity Int  
trial Boolean  
payToAccept Boolean  
documentTemplateId ID  
couponCode String  
paymentMethod SignupPaymentMethodAttributes  

ResponseLink to Response section

Name Type Description
account Account  
amount Float  
currencyId String  
errors List (String)  
portalSessionToken String  
quote Quote  
tenant Tenant