priceLists

Graphql fields and variables for the priceLists query

Scope required: product:read

For a complete list of possible response fields see the PriceListConnection type.

query priceLists ($after: String, $before: String, $first: Int, $last: Int, $filter: String, $sort: String, $viewId: ID, $format: String) {
  priceLists (after: $after, before: $before, first: $first, last: $last, filter: $filter, sort: $sort, viewId: $viewId, format: $format) {
    edges {
      cursor
      node {
        basePrice
        code
        createdAt
        currencyId
        id
        isVisible
        monthlyBasePrice
        name
        periodMonths
        planId
        priceAdjustmentPercentage
        priceDescription
        productId
        renewalTermMonths
        showPriceAsMonthly
        sku
        trialAllowed
        trialLengthDays
        updatedAt
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
  }
}

Arguments

Name
Type
Description

after

String

Returns the elements in the list that come after the specified cursor.

before

String

Returns the elements in the list that come before the specified cursor.

first

Int

Returns the first n elements from the list.

last

Int

Returns the last n elements from the list.

filter

String

sort

String

viewId

ID

format

String

Response

Last updated

Was this helpful?