SubscriptionAttributes

The SubscriptionAttributes input type in Bunny's GraphQL API, with its fields and an example.

{
  "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",
      "accountCode": "",
      "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,
    "parentAccountId": "456123",
    "invoicedAccountId": "456123",
    "payingAccountId": "456123"
  },
  "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"
        }
      ]
    }
  ],
  "platformId": "456123",
  "platformCode": "",
  "tenantCode": "",
  "tenantName": "",
  "tenant": {
    "name": "",
    "code": "",
    "subdomain": "",
    "tenantUuid": "",
    "accountId": "456123",
    "platformId": "456123",
    "platformCode": "",
    "lastLogin": "2022-06-01T00:00:00Z"
  },
  "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",
  "couponCode": ""
}
Name Type Description
accountId ID The id of the company or organization that is subscribing
accountCode String The code of the company or organization that is subscribing
account AccountAttributes Fields to create the company or organization that is subscribing
priceListCode String The code of the plan to subscribe to
priceListId ID The id of the plan to subscribe to
priceListCharges List (QuoteChargeAttributes) Set custom quantity, price and discount rate for charges
discounts List (QuoteChargeAttributes) Set custom discount amount for price list charges
platformId ID The id of the platform to provision the subscription on
platformCode String The code of the platform to provision the subscription on
tenantCode String A unique code that represents the tenant in a SaaS application
tenantName String The name of the tenant. Typically this is the account name
tenant TenantAttributes Fields to create a tenant for the subscription
startDate ISO8601Date Date that the subscription starts
endDate ISO8601Date Date that the subscription ends
trial Boolean Indicates if the subscription is a trial or immediately active
trialStartDate ISO8601Date Overrides the default trial start date
evergreen Boolean Indicates if the subscription should be renewed automatically
renewalTermMonths Int Number of months for the renewal term
priceAdjustmentTiming PriceAdjustmentTiming Timing of the price adjustment
priceAdjustmentPercentage Float Percentage of the price adjustment
priceAdjustmentAction PriceAdjustmentAction Action to take when the price is adjusted
trialExpirationAction TrialExpirationAction Action to take when trial expires
couponCode String Code of a coupon to apply to the subscription