subscriptionTrialConvert

Graphql fields and variables for the subscriptionTrialConvert mutation

Convert an existing trial subscription into a paid subscription

Scope required: standard:write

mutation subscriptionTrialConvert ($subscriptionId: ID!, $paymentId: ID!, $priceListId: ID!, $priceListCode: String!) {
  subscriptionTrialConvert (subscriptionId: $subscriptionId, paymentId: $paymentId, priceListId: $priceListId, priceListCode: $priceListCode) {
      errors
      invoice {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        baseCurrencyTotal
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        hasPaymentMethod
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        paymentFailedAt
        paymentFailureReason
        poNumber
        portalUrl
        quoteId
        sendInvoiceTo
        smallUnitAmountDue
        subtotal
        taxAmount
        taxRate
        updatedAt
        url
        uuid
      }
      paymentApplications
      subscription {
        accountId
        cancellationDate
        createdAt
        currencyId
        currentPeriod
        daysLeftInTrial
        endDate
        evergreen
        id
        name
        period
        priceAdjustmentAllowed
        priceAdjustmentLastDate
        priceAdjustmentPercentage
        priceListId
        provisioningRequired
        rampIntervalMonths
        renewalSummary
        renewalTermMonths
        startDate
        trialEndDate
        trialPeriod
        trialStartDate
        updatedAt
      }
  }
}

Arguments

{
  "subscriptionId": "456123",
  "paymentId": "456123",
  "priceListId": "456123",
  "priceListCode": ""
}

Name	Type	Description
subscriptionId	ID
paymentId	ID
priceListId	ID
priceListCode	String

Response

Name	Type	Description
errors	List (String)
invoice	Invoice
paymentApplications	List (PaymentApplication)
subscription	Subscription