subscriptionCreate

Graphql fields and variables for the subscriptionCreate mutation

Create a paid or trial subscription

Scope required: standard:write

For a complete list of input attributes see the SubscriptionAttributes type

mutation subscriptionCreate ($attributes: SubscriptionAttributes!, $billingDay: Int!) {
  subscriptionCreate (attributes: $attributes, billingDay: $billingDay) {
      errors
      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

{
  "attributes": {
    "accountId": "456123",
    "accountCode": "",
    "account": {
      "code": "",
      "accountTypeId": "456123",
      "industryId": "456123",
      "employees": 123,
      "annualRevenue": 123,
      "name": "",
      "billingStreet": "",
      "billingCity": "",
      "billingState": "",
      "billingZip": "",
      "billingCountry": "",
      "billingContactId": "456123",
      "billingContact": {
        "code": "",
        "firstName": "",
        "lastName": "",
        "email": "",
        "salutation": "",
        "title": "",
        "phone": "",
        "mobile": "",
        "mailingStreet": "",
        "mailingCity": "",
        "mailingZip": "",
        "mailingState": "",
        "mailingCountry": "",
        "portalAccess": true,
        "description": "",
        "accountId": "456123",
        "campaignCode": "",
        "linkedinUrl": ""
      },
      "shippingStreet": "",
      "shippingCity": "",
      "shippingState": "",
      "shippingZip": "",
      "shippingCountry": "",
      "description": "",
      "phone": "",
      "fax": "",
      "website": "",
      "currencyId": "456123",
      "taxNumber": "",
      "groupId": "456123",
      "netPaymentDays": 123,
      "draftInvoices": true,
      "newQuoteBuilder": true,
      "duns": "",
      "timezone": "",
      "ownerUserId": "456123",
      "ipAddress": "",
      "entityUseCode": "",
      "linkedinUrl": "",
      "invoiceTemplateId": "456123",
      "entityId": "456123",
      "secondaryBillingContactIds": [
        "456123"
      ],
      "emailsEnabled": true,
      "disableDunning": true,
      "consolidatedBilling": true
    },
    "priceListCode": "",
    "priceListId": "456123",
    "priceListCharges": [
      {
        "id": "456123",
        "name": "",
        "code": "",
        "priceListChargeId": "456123",
        "quantity": 123,
        "discount": "1.00",
        "price": "BigDecimal",
        "subtotal": "BigDecimal",
        "startDate": "2022-06-01",
        "endDate": "2022-06-01",
        "evergreen": true,
        "priceTiers": [
          {
            "starts": 123,
            "price": "BigDecimal"
          }
        ]
      }
    ],
    "discounts": [
      {
        "id": "456123",
        "name": "",
        "code": "",
        "priceListChargeId": "456123",
        "quantity": 123,
        "discount": "1.00",
        "price": "BigDecimal",
        "subtotal": "BigDecimal",
        "startDate": "2022-06-01",
        "endDate": "2022-06-01",
        "evergreen": true,
        "priceTiers": [
          {
            "starts": 123,
            "price": "BigDecimal"
          }
        ]
      }
    ],
    "tenantCode": "",
    "tenantName": "",
    "tenant": {
      "name": "",
      "code": "",
      "subdomain": "",
      "accountId": "456123",
      "platformId": "456123",
      "platformCode": ""
    },
    "startDate": "2022-06-01",
    "endDate": "2022-06-01",
    "trial": true,
    "trialStartDate": "2022-06-01",
    "evergreen": true,
    "renewalTermMonths": 123,
    "priceAdjustmentTiming": "PriceAdjustmentTiming",
    "priceAdjustmentPercentage": "1.00",
    "priceAdjustmentAction": "PriceAdjustmentAction",
    "trialExpirationAction": "TrialExpirationAction"
  },
  "billingDay": 123
}

Name	Type	Description
attributes	SubscriptionAttributes
billingDay	Int

Response

Name	Type	Description
errors	List (String)
subscription	Subscription