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!) {
  subscriptionTrialConvert (subscriptionId: $subscriptionId, paymentId: $paymentId) {
      errors
      invoice {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        poNumber
        portalUrl
        quoteId
        smallUnitAmountDue
        subtotal
        taxAmount
        updatedAt
        url
        uuid
      }
      subscription {
        accountId
        cancellationDate
        createdAt
        currencyId
        endDate
        evergreen
        id
        name
        period
        priceAdjustmentAllowed
        priceAdjustmentLastDate
        priceAdjustmentPercentage
        priceListId
        provisioningRequired
        rampIntervalMonths
        renewalSummary
        renewalTermMonths
        startDate
        trialEndDate
        trialPeriod
        trialStartDate
        updatedAt
      }
  }
}

Arguments

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

Name	Type	Description
subscriptionId	ID
paymentId	ID

Response

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