Skio API Reference

Empower your store with an open GraphQL API that can easily integrate subscription data into your tech stack.

Authorization

Go to your dashboard and click the API button on the left navigation bar. Generate an API token after setting a name and use this token in the request header "authorization" (case sensitive). 

headers: {
  "Content-Type": "application/graphql"
  "authorization": "API <token>"
}

Data model

Skio's data model mirrors the Shopify GraphQL objects.

Skio Shopify
Subscription SubscriptionContract
SubscriptionLine SubscriptionLine
Order Order
OrderLineItem LineItem
StorefrontUser Customer

The platformId field in the Skio API represents the GID which can be used to query Shopify. For example: the platformId of a Subscription would be gid://shopify/SubscriptionContract/12346616394.

Query examples

The GraphQL schema for queries is documented here. Here is an example of using the Skio API to look up subscriptions for a certain user, ordered by creation time.

query getSubscriptions {
  Subscriptions(
    where: {
      StorefrontUser: {email: {_eq: "test@test.com"}}
    }, 
    order_by: {createdAt: desc}
  ) {
    # 09f3526e-1db3-aaaa-1234-871b3444523c
    id
    # gid://shopify/SubscriptionContract/12131
    platformId
    # 2024-01-01T00:00:00.123456+00:00
    createdAt
    StorefrontUser {
      # test@test.com
      email
      # gid://shopify/Customer/1213
      platformId
    }
    # We need to filter out lines which are removed.
    SubscriptionLines(where: {removedAt: {_is_null: true}}) {
      # 12.31
      priceWithoutDiscount
      ProductVariant {
        # Large
        title
        Product {
          # Tuxedo
          title
        }
      }
    }
  }
}

Analytics

If you're trying to ingest all of your subscription data into a data warehouse, our BigQuery integration offers a turn-key solution to do a bulk transfer of all subscription data accessible through this API.

This integration also works with most popular data warehouses like Snowflake, Databricks, Redshift.

Contact

Skio Engineering

help@skio.com

http://www.skio.com/support

Terms of Service

https://skio.com/terms/

API Endpoints
https://graphql.skio.com/v1/graphql

Queries

AddressByPk

Description

fetch data from the table: "Address" using primary key columns

Response

Returns an Address

Arguments
Name Description
id - uuid!

Example

Query
query AddressByPk($id: uuid!) {
  AddressByPk(id: $id) {
    PaymentMethod {
      ...PaymentMethodFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    address1
    address2
    city
    company
    country
    createdAt
    doorCode
    firstName
    id
    lastName
    phoneNumber
    platformId
    province
    storefrontUserId
    updatedAt
    zip
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "AddressByPk": {
      "PaymentMethod": PaymentMethod,
      "StorefrontUser": StorefrontUser,
      "Subscriptions": [Subscription],
      "address1": "xyz789",
      "address2": "abc123",
      "city": "xyz789",
      "company": "abc123",
      "country": "abc123",
      "createdAt": timestamptz,
      "doorCode": "xyz789",
      "firstName": "abc123",
      "id": uuid,
      "lastName": "abc123",
      "phoneNumber": "abc123",
      "platformId": "xyz789",
      "province": "abc123",
      "storefrontUserId": uuid,
      "updatedAt": timestamptz,
      "zip": "xyz789"
    }
  }
}
Queries

Addresses

Description

fetch data from the table: "Address"

Response

Returns [Address!]!

Arguments
Name Description
distinct_on - [Address_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [Address_order_by!] sort the rows by one or more columns
where - Address_bool_exp filter the rows returned

Example

Query
query Addresses(
  $distinct_on: [Address_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [Address_order_by!],
  $where: Address_bool_exp
) {
  Addresses(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    PaymentMethod {
      ...PaymentMethodFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    address1
    address2
    city
    company
    country
    createdAt
    doorCode
    firstName
    id
    lastName
    phoneNumber
    platformId
    province
    storefrontUserId
    updatedAt
    zip
  }
}
Variables
{
  "distinct_on": ["address1"],
  "limit": 987,
  "offset": 123,
  "order_by": [Address_order_by],
  "where": Address_bool_exp
}
Response
{
  "data": {
    "Addresses": [
      {
        "PaymentMethod": PaymentMethod,
        "StorefrontUser": StorefrontUser,
        "Subscriptions": [Subscription],
        "address1": "abc123",
        "address2": "abc123",
        "city": "xyz789",
        "company": "abc123",
        "country": "abc123",
        "createdAt": timestamptz,
        "doorCode": "xyz789",
        "firstName": "abc123",
        "id": uuid,
        "lastName": "abc123",
        "phoneNumber": "xyz789",
        "platformId": "abc123",
        "province": "xyz789",
        "storefrontUserId": uuid,
        "updatedAt": timestamptz,
        "zip": "abc123"
      }
    ]
  }
}
Queries

DiscountByPk

Description

fetch data from the table: "Discount" using primary key columns

Response

Returns a Discount

Arguments
Name Description
id - uuid!

Example

Query
query DiscountByPk($id: uuid!) {
  DiscountByPk(id: $id) {
    CancelFlowSession {
      ...CancelFlowSessionFragment
    }
    Group {
      ...GroupFragment
    }
    GroupPlan {
      ...GroupPlanFragment
    }
    OrderLineItem {
      ...OrderLineItemFragment
    }
    ShippingLine {
      ...ShippingLineFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    SubscriptionLine {
      ...SubscriptionLineFragment
    }
    cancelFlowSessionId
    createdAt
    fixedValue
    groupId
    groupPlanId
    id
    maxTimesUsed
    orderLineItemId
    percentage
    platformId
    redeemCode
    shippingLineId
    subscriptionId
    subscriptionLineId
    timesUsed
    type
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "DiscountByPk": {
      "CancelFlowSession": CancelFlowSession,
      "Group": Group,
      "GroupPlan": GroupPlan,
      "OrderLineItem": OrderLineItem,
      "ShippingLine": ShippingLine,
      "Subscription": Subscription,
      "SubscriptionLine": SubscriptionLine,
      "cancelFlowSessionId": uuid,
      "createdAt": timestamptz,
      "fixedValue": numeric,
      "groupId": uuid,
      "groupPlanId": uuid,
      "id": uuid,
      "maxTimesUsed": 123,
      "orderLineItemId": uuid,
      "percentage": numeric,
      "platformId": "abc123",
      "redeemCode": "abc123",
      "shippingLineId": uuid,
      "subscriptionId": uuid,
      "subscriptionLineId": uuid,
      "timesUsed": 123,
      "type": "abc123",
      "updatedAt": timestamptz
    }
  }
}
Queries

OrderByPk

Description

fetch data from the table: "Order" using primary key columns

Response

Returns an Order

Arguments
Name Description
id - uuid!

Example

Query
query OrderByPk($id: uuid!) {
  OrderByPk(id: $id) {
    OrderLineItems {
      ...OrderLineItemFragment
    }
    PrepaidSubscription {
      ...SubscriptionFragment
    }
    ShippingLines {
      ...ShippingLineFragment
    }
    Site {
      ...SiteFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    cancelledAt
    clientIp
    createdAt
    deletedAt
    deliveredAt
    id
    note
    platformId
    platformNumber
    processedAt
    siteId
    storefrontUserId
    totalPrice
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "OrderByPk": {
      "OrderLineItems": [OrderLineItem],
      "PrepaidSubscription": Subscription,
      "ShippingLines": [ShippingLine],
      "Site": Site,
      "StorefrontUser": StorefrontUser,
      "cancelledAt": timestamptz,
      "clientIp": "xyz789",
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "deliveredAt": timestamptz,
      "id": uuid,
      "note": "abc123",
      "platformId": "abc123",
      "platformNumber": "abc123",
      "processedAt": timestamptz,
      "siteId": uuid,
      "storefrontUserId": uuid,
      "totalPrice": 987.65,
      "updatedAt": timestamp
    }
  }
}
Queries

OrderLineItems

Description

An array relationship

Response

Returns [OrderLineItem!]!

Arguments
Name Description
distinct_on - [OrderLineItem_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [OrderLineItem_order_by!] sort the rows by one or more columns
where - OrderLineItem_bool_exp filter the rows returned

Example

Query
query OrderLineItems(
  $distinct_on: [OrderLineItem_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [OrderLineItem_order_by!],
  $where: OrderLineItem_bool_exp
) {
  OrderLineItems(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    Discounts {
      ...DiscountFragment
    }
    GroupIfInitialOrder {
      ...GroupFragment
    }
    Order {
      ...OrderFragment
    }
    ProductVariant {
      ...ProductVariantFragment
    }
    SubscriptionLine {
      ...SubscriptionLineFragment
    }
    TaxLines {
      ...TaxLineFragment
    }
    attributionGroupId
    createdAt
    customAttributes
    groupId
    id
    orderId
    platformId
    priceWithoutDiscount
    productVariantId
    quantity
    subscriptionLineId
    updatedAt
  }
}
Variables
{
  "distinct_on": ["attributionGroupId"],
  "limit": 123,
  "offset": 987,
  "order_by": [OrderLineItem_order_by],
  "where": OrderLineItem_bool_exp
}
Response
{
  "data": {
    "OrderLineItems": [
      {
        "Discounts": [Discount],
        "GroupIfInitialOrder": Group,
        "Order": Order,
        "ProductVariant": ProductVariant,
        "SubscriptionLine": SubscriptionLine,
        "TaxLines": [TaxLine],
        "attributionGroupId": uuid,
        "createdAt": timestamptz,
        "customAttributes": jsonb,
        "groupId": uuid,
        "id": uuid,
        "orderId": uuid,
        "platformId": "xyz789",
        "priceWithoutDiscount": numeric,
        "productVariantId": uuid,
        "quantity": 123,
        "subscriptionLineId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

Orders

Description

An array relationship

Response

Returns [Order!]!

Arguments
Name Description
distinct_on - [Order_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [Order_order_by!] sort the rows by one or more columns
where - Order_bool_exp filter the rows returned

Example

Query
query Orders(
  $distinct_on: [Order_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [Order_order_by!],
  $where: Order_bool_exp
) {
  Orders(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    OrderLineItems {
      ...OrderLineItemFragment
    }
    PrepaidSubscription {
      ...SubscriptionFragment
    }
    ShippingLines {
      ...ShippingLineFragment
    }
    Site {
      ...SiteFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    cancelledAt
    clientIp
    createdAt
    deletedAt
    deliveredAt
    id
    note
    platformId
    platformNumber
    processedAt
    siteId
    storefrontUserId
    totalPrice
    updatedAt
  }
}
Variables
{
  "distinct_on": ["cancelledAt"],
  "limit": 987,
  "offset": 123,
  "order_by": [Order_order_by],
  "where": Order_bool_exp
}
Response
{
  "data": {
    "Orders": [
      {
        "OrderLineItems": [OrderLineItem],
        "PrepaidSubscription": Subscription,
        "ShippingLines": [ShippingLine],
        "Site": Site,
        "StorefrontUser": StorefrontUser,
        "cancelledAt": timestamptz,
        "clientIp": "xyz789",
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "deliveredAt": timestamptz,
        "id": uuid,
        "note": "xyz789",
        "platformId": "xyz789",
        "platformNumber": "abc123",
        "processedAt": timestamptz,
        "siteId": uuid,
        "storefrontUserId": uuid,
        "totalPrice": 987.65,
        "updatedAt": timestamp
      }
    ]
  }
}
Queries

Policies

Description

fetch data from the table: "Policy"

Response

Returns [Policy!]!

Arguments
Name Description
distinct_on - [Policy_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [Policy_order_by!] sort the rows by one or more columns
where - Policy_bool_exp filter the rows returned

Example

Query
query Policies(
  $distinct_on: [Policy_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [Policy_order_by!],
  $where: Policy_bool_exp
) {
  Policies(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    Anchors {
      ...AnchorFragment
    }
    SellingPlansByBillingPolicy {
      ...SellingPlanFragment
    }
    SellingPlansByDeliveryPolicy {
      ...SellingPlanFragment
    }
    SellingPlansByPrepaidDeliveryPolicy {
      ...SellingPlanFragment
    }
    SubscriptionsByBillingPolicy {
      ...SubscriptionFragment
    }
    SubscriptionsByDeliveryPolicy {
      ...SubscriptionFragment
    }
    SubscriptionsByPrepaidDeliveryPolicy {
      ...SubscriptionFragment
    }
    createdAt
    id
    interval
    intervalCount
    isMaxCycleV2
    maxCycles
    minCycles
    updatedAt
  }
}
Variables
{
  "distinct_on": ["createdAt"],
  "limit": 123,
  "offset": 987,
  "order_by": [Policy_order_by],
  "where": Policy_bool_exp
}
Response
{
  "data": {
    "Policies": [
      {
        "Anchors": [Anchor],
        "SellingPlansByBillingPolicy": [SellingPlan],
        "SellingPlansByDeliveryPolicy": [SellingPlan],
        "SellingPlansByPrepaidDeliveryPolicy": [
          SellingPlan
        ],
        "SubscriptionsByBillingPolicy": [Subscription],
        "SubscriptionsByDeliveryPolicy": [Subscription],
        "SubscriptionsByPrepaidDeliveryPolicy": [
          Subscription
        ],
        "createdAt": timestamptz,
        "id": uuid,
        "interval": "xyz789",
        "intervalCount": 987,
        "isMaxCycleV2": true,
        "maxCycles": 987,
        "minCycles": 123,
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

PolicyByPk

Description

fetch data from the table: "Policy" using primary key columns

Response

Returns a Policy

Arguments
Name Description
id - uuid!

Example

Query
query PolicyByPk($id: uuid!) {
  PolicyByPk(id: $id) {
    Anchors {
      ...AnchorFragment
    }
    SellingPlansByBillingPolicy {
      ...SellingPlanFragment
    }
    SellingPlansByDeliveryPolicy {
      ...SellingPlanFragment
    }
    SellingPlansByPrepaidDeliveryPolicy {
      ...SellingPlanFragment
    }
    SubscriptionsByBillingPolicy {
      ...SubscriptionFragment
    }
    SubscriptionsByDeliveryPolicy {
      ...SubscriptionFragment
    }
    SubscriptionsByPrepaidDeliveryPolicy {
      ...SubscriptionFragment
    }
    createdAt
    id
    interval
    intervalCount
    isMaxCycleV2
    maxCycles
    minCycles
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "PolicyByPk": {
      "Anchors": [Anchor],
      "SellingPlansByBillingPolicy": [SellingPlan],
      "SellingPlansByDeliveryPolicy": [SellingPlan],
      "SellingPlansByPrepaidDeliveryPolicy": [
        SellingPlan
      ],
      "SubscriptionsByBillingPolicy": [Subscription],
      "SubscriptionsByDeliveryPolicy": [Subscription],
      "SubscriptionsByPrepaidDeliveryPolicy": [
        Subscription
      ],
      "createdAt": timestamptz,
      "id": uuid,
      "interval": "abc123",
      "intervalCount": 987,
      "isMaxCycleV2": false,
      "maxCycles": 123,
      "minCycles": 123,
      "updatedAt": timestamptz
    }
  }
}
Queries

PricingPolicies

Description

An array relationship

Response

Returns [PricingPolicy!]!

Arguments
Name Description
distinct_on - [PricingPolicy_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [PricingPolicy_order_by!] sort the rows by one or more columns
where - PricingPolicy_bool_exp filter the rows returned

Example

Query
query PricingPolicies(
  $distinct_on: [PricingPolicy_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [PricingPolicy_order_by!],
  $where: PricingPolicy_bool_exp
) {
  PricingPolicies(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    SellingPlan {
      ...SellingPlanFragment
    }
    afterCycle
    createdAt
    fixedPrice
    id
    percentageOff
    sellingPlanId
    sellingPlanPricingPolicyAdjustmentType
    updatedAt
  }
}
Variables
{
  "distinct_on": ["afterCycle"],
  "limit": 123,
  "offset": 987,
  "order_by": [PricingPolicy_order_by],
  "where": PricingPolicy_bool_exp
}
Response
{
  "data": {
    "PricingPolicies": [
      {
        "SellingPlan": SellingPlan,
        "afterCycle": 123,
        "createdAt": timestamptz,
        "fixedPrice": numeric,
        "id": uuid,
        "percentageOff": numeric,
        "sellingPlanId": uuid,
        "sellingPlanPricingPolicyAdjustmentType": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

PricingPolicyByPk

Description

fetch data from the table: "PricingPolicy" using primary key columns

Response

Returns a PricingPolicy

Arguments
Name Description
id - uuid!

Example

Query
query PricingPolicyByPk($id: uuid!) {
  PricingPolicyByPk(id: $id) {
    SellingPlan {
      ...SellingPlanFragment
    }
    afterCycle
    createdAt
    fixedPrice
    id
    percentageOff
    sellingPlanId
    sellingPlanPricingPolicyAdjustmentType
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "PricingPolicyByPk": {
      "SellingPlan": SellingPlan,
      "afterCycle": 123,
      "createdAt": timestamptz,
      "fixedPrice": numeric,
      "id": uuid,
      "percentageOff": numeric,
      "sellingPlanId": uuid,
      "sellingPlanPricingPolicyAdjustmentType": "abc123",
      "updatedAt": timestamptz
    }
  }
}
Queries

ProductByPk

Description

fetch data from the table: "Product" using primary key columns

Response

Returns a Product

Arguments
Name Description
id - uuid!

Example

Query
query ProductByPk($id: uuid!) {
  ProductByPk(id: $id) {
    DynamicBox {
      ...DynamicBoxFragment
    }
    ProductVariants {
      ...ProductVariantFragment
    }
    Site {
      ...SiteFragment
    }
    canUpsell
    createdAt
    deletedAt
    description
    hideOn1TimeUpsells
    id
    imageSrc
    images
    limitOneTimeUpsellQuantity
    metafields
    oneTimeUpsellPercentageOff
    platformId
    shopifyTags
    siteId
    slug
    smsOrder
    status
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ProductByPk": {
      "DynamicBox": DynamicBox,
      "ProductVariants": [ProductVariant],
      "Site": Site,
      "canUpsell": false,
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "description": "xyz789",
      "hideOn1TimeUpsells": true,
      "id": uuid,
      "imageSrc": "abc123",
      "images": jsonb,
      "limitOneTimeUpsellQuantity": true,
      "metafields": jsonb,
      "oneTimeUpsellPercentageOff": numeric,
      "platformId": "abc123",
      "shopifyTags": jsonb,
      "siteId": uuid,
      "slug": "abc123",
      "smsOrder": 123,
      "status": "xyz789",
      "title": "xyz789",
      "updatedAt": timestamptz
    }
  }
}
Queries

ProductVariantByPk

Description

fetch data from the table: "ProductVariant" using primary key columns

Response

Returns a ProductVariant

Arguments
Name Description
id - uuid!

Example

Query
query ProductVariantByPk($id: uuid!) {
  ProductVariantByPk(id: $id) {
    DynamicBox_SelectableProductVariants {
      ...DynamicBox_SelectableProductVariantFragment
    }
    OrderLineItems {
      ...OrderLineItemFragment
    }
    Product {
      ...ProductFragment
    }
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    compareAtPrice
    createdAt
    deletedAt
    id
    image
    marketPrices
    outOfStockAt
    platformId
    price
    productId
    sku
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ProductVariantByPk": {
      "DynamicBox_SelectableProductVariants": [
        DynamicBox_SelectableProductVariant
      ],
      "OrderLineItems": [OrderLineItem],
      "Product": Product,
      "SellingPlanGroupResources": [
        SellingPlanGroupResource
      ],
      "SubscriptionLines": [SubscriptionLine],
      "compareAtPrice": numeric,
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "id": uuid,
      "image": "abc123",
      "marketPrices": jsonb,
      "outOfStockAt": timestamptz,
      "platformId": "xyz789",
      "price": numeric,
      "productId": uuid,
      "sku": "abc123",
      "title": "xyz789",
      "updatedAt": timestamptz
    }
  }
}
Queries

ProductVariants

Description

An array relationship

Response

Returns [ProductVariant!]!

Arguments
Name Description
distinct_on - [ProductVariant_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [ProductVariant_order_by!] sort the rows by one or more columns
where - ProductVariant_bool_exp filter the rows returned

Example

Query
query ProductVariants(
  $distinct_on: [ProductVariant_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [ProductVariant_order_by!],
  $where: ProductVariant_bool_exp
) {
  ProductVariants(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    DynamicBox_SelectableProductVariants {
      ...DynamicBox_SelectableProductVariantFragment
    }
    OrderLineItems {
      ...OrderLineItemFragment
    }
    Product {
      ...ProductFragment
    }
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    compareAtPrice
    createdAt
    deletedAt
    id
    image
    marketPrices
    outOfStockAt
    platformId
    price
    productId
    sku
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": ["compareAtPrice"],
  "limit": 987,
  "offset": 123,
  "order_by": [ProductVariant_order_by],
  "where": ProductVariant_bool_exp
}
Response
{
  "data": {
    "ProductVariants": [
      {
        "DynamicBox_SelectableProductVariants": [
          DynamicBox_SelectableProductVariant
        ],
        "OrderLineItems": [OrderLineItem],
        "Product": Product,
        "SellingPlanGroupResources": [
          SellingPlanGroupResource
        ],
        "SubscriptionLines": [SubscriptionLine],
        "compareAtPrice": numeric,
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "id": uuid,
        "image": "abc123",
        "marketPrices": jsonb,
        "outOfStockAt": timestamptz,
        "platformId": "xyz789",
        "price": numeric,
        "productId": uuid,
        "sku": "xyz789",
        "title": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

Products

Description

An array relationship

Response

Returns [Product!]!

Arguments
Name Description
distinct_on - [Product_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [Product_order_by!] sort the rows by one or more columns
where - Product_bool_exp filter the rows returned

Example

Query
query Products(
  $distinct_on: [Product_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [Product_order_by!],
  $where: Product_bool_exp
) {
  Products(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    DynamicBox {
      ...DynamicBoxFragment
    }
    ProductVariants {
      ...ProductVariantFragment
    }
    Site {
      ...SiteFragment
    }
    canUpsell
    createdAt
    deletedAt
    description
    hideOn1TimeUpsells
    id
    imageSrc
    images
    limitOneTimeUpsellQuantity
    metafields
    oneTimeUpsellPercentageOff
    platformId
    shopifyTags
    siteId
    slug
    smsOrder
    status
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": ["canUpsell"],
  "limit": 987,
  "offset": 123,
  "order_by": [Product_order_by],
  "where": Product_bool_exp
}
Response
{
  "data": {
    "Products": [
      {
        "DynamicBox": DynamicBox,
        "ProductVariants": [ProductVariant],
        "Site": Site,
        "canUpsell": true,
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "description": "xyz789",
        "hideOn1TimeUpsells": true,
        "id": uuid,
        "imageSrc": "abc123",
        "images": jsonb,
        "limitOneTimeUpsellQuantity": false,
        "metafields": jsonb,
        "oneTimeUpsellPercentageOff": numeric,
        "platformId": "xyz789",
        "shopifyTags": jsonb,
        "siteId": uuid,
        "slug": "abc123",
        "smsOrder": 123,
        "status": "xyz789",
        "title": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

SiteByPk

Description

fetch data from the table: "Site" using primary key columns

Response

Returns a Site

Arguments
Name Description
id - uuid!

Example

Query
query SiteByPk($id: uuid!) {
  SiteByPk(id: $id) {
    Holidays {
      ...HolidayFragment
    }
    Notifications {
      ...NotificationFragment
    }
    Products {
      ...ProductFragment
    }
    SkioSmsMessagingHistory {
      ...SkioSmsMessagingHistoryFragment
    }
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    Theme {
      ...ThemeFragment
    }
    Theme2 {
      ...Theme2Fragment
    }
    ianaTimezone
    id
    qaAuthSettings
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SiteByPk": {
      "Holidays": [Holiday],
      "Notifications": [Notification],
      "Products": [Product],
      "SkioSmsMessagingHistory": [
        SkioSmsMessagingHistory
      ],
      "StorefrontUsers": [StorefrontUser],
      "Theme": Theme,
      "Theme2": Theme2,
      "ianaTimezone": "xyz789",
      "id": uuid,
      "qaAuthSettings": jsonb
    }
  }
}
Queries

StorefrontUsers

Description

An array relationship

Response

Returns [StorefrontUser!]!

Arguments
Name Description
distinct_on - [StorefrontUser_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [StorefrontUser_order_by!] sort the rows by one or more columns
where - StorefrontUser_bool_exp filter the rows returned

Example

Query
query StorefrontUsers(
  $distinct_on: [StorefrontUser_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [StorefrontUser_order_by!],
  $where: StorefrontUser_bool_exp
) {
  StorefrontUsers(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    AuditLogs {
      ...AuditLogFragment
    }
    BackupPaymentMethod {
      ...PaymentMethodFragment
    }
    Orders {
      ...OrderFragment
    }
    PaymentMethods {
      ...PaymentMethodFragment
    }
    ShippingAddresses {
      ...AddressFragment
    }
    Site {
      ...SiteFragment
    }
    SkioSmsMessagingHistory {
      ...SkioSmsMessagingHistoryFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    User {
      ...UserFragment
    }
    createdAt
    email
    firstName
    id
    lastName
    phoneNumber
    platformId
    qaToken
    redactedAt
    removedAt
    shopifyTags
    siteId
    updatedAt
  }
}
Variables
{
  "distinct_on": ["createdAt"],
  "limit": 987,
  "offset": 123,
  "order_by": [StorefrontUser_order_by],
  "where": StorefrontUser_bool_exp
}
Response
{
  "data": {
    "StorefrontUsers": [
      {
        "AuditLogs": [AuditLog],
        "BackupPaymentMethod": PaymentMethod,
        "Orders": [Order],
        "PaymentMethods": [PaymentMethod],
        "ShippingAddresses": [Address],
        "Site": Site,
        "SkioSmsMessagingHistory": [
          SkioSmsMessagingHistory
        ],
        "Subscriptions": [Subscription],
        "User": User,
        "createdAt": timestamptz,
        "email": "xyz789",
        "firstName": "abc123",
        "id": uuid,
        "lastName": "abc123",
        "phoneNumber": "abc123",
        "platformId": "xyz789",
        "qaToken": uuid,
        "redactedAt": timestamptz,
        "removedAt": timestamptz,
        "shopifyTags": jsonb,
        "siteId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

SubscriptionByPk

Description

fetch data from the table: "Subscription" using primary key columns

Response

Returns a Subscription

Arguments
Name Description
id - uuid!

Example

Query
query SubscriptionByPk($id: uuid!) {
  SubscriptionByPk(id: $id) {
    AuditLogs {
      ...AuditLogFragment
    }
    BillingPolicy {
      ...PolicyFragment
    }
    CancelFlowSessions {
      ...CancelFlowSessionFragment
    }
    CancelFlowV2Sessions {
      ...CancelFlowV2SessionFragment
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    Discounts {
      ...DiscountFragment
    }
    FulfillmentOrders {
      ...OrderFragment
    }
    NotificationLogs {
      ...NotificationLogFragment
    }
    PaymentMethod {
      ...PaymentMethodFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PrepaidGiftRecipient {
      ...StorefrontUserFragment
    }
    PrepaidSubscriptionLines {
      ...SubscriptionLineFragment
    }
    ShippingAddress {
      ...AddressFragment
    }
    Site {
      ...SiteFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    SurpriseDelightSessions {
      ...SurpriseDelightSessionsFragment
    }
    billingPolicyId
    cancelledAt
    createdAt
    currencyCode
    customAttributes
    cyclesCompleted
    deliveryPolicyId
    deliveryPrice
    deliveryPriceOverride
    id
    isPickup
    lastBillingAttemptAt
    metadata
    migrationIndex
    nextBillingDate
    note
    originOrder {
      ...OrderFragment
    }
    originOrderId
    platformId
    prepaidDeliveryPolicyId
    prepaidProductPricesPerDelivery
    shippingAddressId
    siteId
    status
    statusContext
    storefrontUserId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SubscriptionByPk": {
      "AuditLogs": [AuditLog],
      "BillingPolicy": Policy,
      "CancelFlowSessions": [CancelFlowSession],
      "CancelFlowV2Sessions": [CancelFlowV2Session],
      "DeliveryPolicy": Policy,
      "Discounts": [Discount],
      "FulfillmentOrders": [Order],
      "NotificationLogs": [NotificationLog],
      "PaymentMethod": PaymentMethod,
      "PrepaidDeliveryPolicy": Policy,
      "PrepaidGiftRecipient": StorefrontUser,
      "PrepaidSubscriptionLines": [SubscriptionLine],
      "ShippingAddress": Address,
      "Site": Site,
      "StorefrontUser": StorefrontUser,
      "SubscriptionLines": [SubscriptionLine],
      "SurpriseDelightSessions": [
        SurpriseDelightSessions
      ],
      "billingPolicyId": uuid,
      "cancelledAt": timestamptz,
      "createdAt": timestamptz,
      "currencyCode": "USD",
      "customAttributes": jsonb,
      "cyclesCompleted": 1,
      "deliveryPolicyId": uuid,
      "deliveryPrice": numeric,
      "deliveryPriceOverride": null,
      "id": uuid,
      "isPickup": true,
      "lastBillingAttemptAt": timestamptz,
      "metadata": jsonb,
      "migrationIndex": null,
      "nextBillingDate": timestamptz,
      "note": "test",
      "originOrder": Order,
      "originOrderId": uuid,
      "platformId": "gid://shopify/SubscriptionContract/12346616394",
      "prepaidDeliveryPolicyId": uuid,
      "prepaidProductPricesPerDelivery": jsonb,
      "shippingAddressId": uuid,
      "siteId": uuid,
      "status": "ACTIVE",
      "statusContext": null,
      "storefrontUserId": uuid,
      "updatedAt": timestamptz
    }
  }
}
Queries

SubscriptionLines

Description

An array relationship

Response

Returns [SubscriptionLine!]!

Arguments
Name Description
distinct_on - [SubscriptionLine_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [SubscriptionLine_order_by!] sort the rows by one or more columns
where - SubscriptionLine_bool_exp filter the rows returned

Example

Query
query SubscriptionLines(
  $distinct_on: [SubscriptionLine_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [SubscriptionLine_order_by!],
  $where: SubscriptionLine_bool_exp
) {
  SubscriptionLines(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    Discounts {
      ...DiscountFragment
    }
    Group {
      ...GroupFragment
    }
    OrderLineItems {
      ...OrderLineItemFragment
    }
    OriginalSellingPlan {
      ...SellingPlanFragment
    }
    PrepaidSubscription {
      ...SubscriptionFragment
    }
    ProductVariant {
      ...ProductVariantFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    createdAt
    customAttributes
    groupId
    id
    isPrepaid
    ordersRemaining
    platformId
    prepaidSubscriptionId
    priceWithoutDiscount
    productVariantId
    quantity
    reChargeId
    removedAt
    sellingPlanId
    subscriptionId
    taxable
    titleOverride
    updatedAt
  }
}
Variables
{
  "distinct_on": ["createdAt"],
  "limit": 987,
  "offset": 987,
  "order_by": [SubscriptionLine_order_by],
  "where": SubscriptionLine_bool_exp
}
Response
{
  "data": {
    "SubscriptionLines": [
      {
        "Discounts": [Discount],
        "Group": Group,
        "OrderLineItems": [OrderLineItem],
        "OriginalSellingPlan": SellingPlan,
        "PrepaidSubscription": Subscription,
        "ProductVariant": ProductVariant,
        "Subscription": Subscription,
        "createdAt": timestamptz,
        "customAttributes": jsonb,
        "groupId": uuid,
        "id": uuid,
        "isPrepaid": false,
        "ordersRemaining": 123,
        "platformId": "abc123",
        "prepaidSubscriptionId": uuid,
        "priceWithoutDiscount": numeric,
        "productVariantId": uuid,
        "quantity": 123,
        "reChargeId": "abc123",
        "removedAt": timestamptz,
        "sellingPlanId": uuid,
        "subscriptionId": uuid,
        "taxable": false,
        "titleOverride": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

Subscriptions

Description

An array relationship

Response

Returns [Subscription!]!

Arguments
Name Description
distinct_on - [Subscription_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [Subscription_order_by!] sort the rows by one or more columns
where - Subscription_bool_exp filter the rows returned

Example

Query
query Subscriptions(
  $distinct_on: [Subscription_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [Subscription_order_by!],
  $where: Subscription_bool_exp
) {
  Subscriptions(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    AuditLogs {
      ...AuditLogFragment
    }
    BillingPolicy {
      ...PolicyFragment
    }
    CancelFlowSessions {
      ...CancelFlowSessionFragment
    }
    CancelFlowV2Sessions {
      ...CancelFlowV2SessionFragment
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    Discounts {
      ...DiscountFragment
    }
    FulfillmentOrders {
      ...OrderFragment
    }
    NotificationLogs {
      ...NotificationLogFragment
    }
    PaymentMethod {
      ...PaymentMethodFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PrepaidGiftRecipient {
      ...StorefrontUserFragment
    }
    PrepaidSubscriptionLines {
      ...SubscriptionLineFragment
    }
    ShippingAddress {
      ...AddressFragment
    }
    Site {
      ...SiteFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    SurpriseDelightSessions {
      ...SurpriseDelightSessionsFragment
    }
    billingPolicyId
    cancelledAt
    createdAt
    currencyCode
    customAttributes
    cyclesCompleted
    deliveryPolicyId
    deliveryPrice
    deliveryPriceOverride
    id
    isPickup
    lastBillingAttemptAt
    metadata
    migrationIndex
    nextBillingDate
    note
    originOrder {
      ...OrderFragment
    }
    originOrderId
    platformId
    prepaidDeliveryPolicyId
    prepaidProductPricesPerDelivery
    shippingAddressId
    siteId
    status
    statusContext
    storefrontUserId
    updatedAt
  }
}
Variables
{
  "distinct_on": ["billingPolicyId"],
  "limit": 987,
  "offset": 987,
  "order_by": [Subscription_order_by],
  "where": Subscription_bool_exp
}
Response
{
  "data": {
    "Subscriptions": [
      {
        "AuditLogs": [AuditLog],
        "BillingPolicy": Policy,
        "CancelFlowSessions": [CancelFlowSession],
        "CancelFlowV2Sessions": [CancelFlowV2Session],
        "DeliveryPolicy": Policy,
        "Discounts": [Discount],
        "FulfillmentOrders": [Order],
        "NotificationLogs": [NotificationLog],
        "PaymentMethod": PaymentMethod,
        "PrepaidDeliveryPolicy": Policy,
        "PrepaidGiftRecipient": StorefrontUser,
        "PrepaidSubscriptionLines": [SubscriptionLine],
        "ShippingAddress": Address,
        "Site": Site,
        "StorefrontUser": StorefrontUser,
        "SubscriptionLines": [SubscriptionLine],
        "SurpriseDelightSessions": [
          SurpriseDelightSessions
        ],
        "billingPolicyId": uuid,
        "cancelledAt": timestamptz,
        "createdAt": timestamptz,
        "currencyCode": "USD",
        "customAttributes": jsonb,
        "cyclesCompleted": 1,
        "deliveryPolicyId": uuid,
        "deliveryPrice": numeric,
        "deliveryPriceOverride": null,
        "id": uuid,
        "isPickup": false,
        "lastBillingAttemptAt": timestamptz,
        "metadata": jsonb,
        "migrationIndex": null,
        "nextBillingDate": timestamptz,
        "note": "test",
        "originOrder": Order,
        "originOrderId": uuid,
        "platformId": "gid://shopify/SubscriptionContract/12346616394",
        "prepaidDeliveryPolicyId": uuid,
        "prepaidProductPricesPerDelivery": jsonb,
        "shippingAddressId": uuid,
        "siteId": uuid,
        "status": "ACTIVE",
        "statusContext": null,
        "storefrontUserId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}
Queries

SurpriseDelightSessions

Description

An array relationship

Response

Returns [SurpriseDelightSessions!]!

Arguments
Name Description
distinct_on - [SurpriseDelightSessions_select_column!] distinct select on columns
limit - Int limit the number of rows returned
offset - Int skip the first n rows. Use only with order_by
order_by - [SurpriseDelightSessions_order_by!] sort the rows by one or more columns
where - SurpriseDelightSessions_bool_exp filter the rows returned

Example

Query
query SurpriseDelightSessions(
  $distinct_on: [SurpriseDelightSessions_select_column!],
  $limit: Int,
  $offset: Int,
  $order_by: [SurpriseDelightSessions_order_by!],
  $where: SurpriseDelightSessions_bool_exp
) {
  SurpriseDelightSessions(
    distinct_on: $distinct_on,
    limit: $limit,
    offset: $offset,
    order_by: $order_by,
    where: $where
  ) {
    Subscription {
      ...SubscriptionFragment
    }
    created_at
    group
    id
    ruleId
    subscriptionId
  }
}
Variables
{
  "distinct_on": ["created_at"],
  "limit": 123,
  "offset": 987,
  "order_by": [SurpriseDelightSessions_order_by],
  "where": SurpriseDelightSessions_bool_exp
}
Response
{
  "data": {
    "SurpriseDelightSessions": [
      {
        "Subscription": Subscription,
        "created_at": timestamptz,
        "group": "xyz789",
        "id": uuid,
        "ruleId": uuid,
        "subscriptionId": uuid
      }
    ]
  }
}

Mutations

addProductVariantToSellingPlanGroup

Description

Add a product variant to selling plan group

Response

Returns an addProductVariantToSellingPlanGroupOutput

Arguments
Name Description
input - addProductVariantToSellingPlanGroupInput!

Example

Query
mutation addProductVariantToSellingPlanGroup($input: addProductVariantToSellingPlanGroupInput!) {
  addProductVariantToSellingPlanGroup(input: $input) {
    ok
  }
}
Variables
{"input": addProductVariantToSellingPlanGroupInput}
Response
{"data": {"addProductVariantToSellingPlanGroup": {"ok": true}}}
Mutations

addSubscriptionLine

Description

Adds a product to a subscription, with the option of adding it as a one time item (only valid for the next order). The price is optional, by default it will use the price from Shopify with the closest matching selling plan discount. This doesn't support prepaid subscriptions.

Response

Returns an AddSubscriptionLineOutput

Arguments
Name Description
input - AddSubscriptionLineInput!

Example

Query
mutation addSubscriptionLine($input: AddSubscriptionLineInput!) {
  addSubscriptionLine(input: $input) {
    ok
  }
}
Variables
{"input": AddSubscriptionLineInput}
Response
{"data": {"addSubscriptionLine": {"ok": true}}}
Mutations

applyDiscountCode

Description

Apply a discount code on a subscription

Response

Returns an ApplyDiscountCodeOutput

Arguments
Name Description
input - ApplyDiscountCodeInput!

Example

Query
mutation applyDiscountCode($input: ApplyDiscountCodeInput!) {
  applyDiscountCode(input: $input) {
    message
    ok
  }
}
Variables
{"input": ApplyDiscountCodeInput}
Response
{
  "data": {
    "applyDiscountCode": {
      "message": "xyz789",
      "ok": true
    }
  }
}
Mutations

cancelSubscription

Description

Cancels a specific subscription and associated SubscriptionContract on Shopify. If the subscription is a prepaid subscription, then first calculate remaining shipments and set maxcycles such that subscription will be killed once remaining shipments are processed.

Response

Returns a CancelSubscriptionOutput

Arguments
Name Description
input - CancelSubscriptionInput!

Example

Query
mutation cancelSubscription($input: CancelSubscriptionInput!) {
  cancelSubscription(input: $input) {
    ok
  }
}
Variables
{"input": CancelSubscriptionInput}
Response
{"data": {"cancelSubscription": {"ok": true}}}
Mutations

createSubscription

Description

Creates a manual subscription through Skio with the given inputs

Response

Returns a CreateSubscriptionOutput

Arguments
Name Description
input - CreateSubscriptionInput!

Example

Query
mutation createSubscription($input: CreateSubscriptionInput!) {
  createSubscription(input: $input) {
    id
    platformId
  }
}
Variables
{"input": CreateSubscriptionInput}
Response
{
  "data": {
    "createSubscription": {
      "id": uuid,
      "platformId": "xyz789"
    }
  }
}
Mutations

pauseSubscription

Description

Pause a subscription

Response

Returns a pauseSubscriptionOutput

Arguments
Name Description
input - pauseSubscriptionInput!

Example

Query
mutation pauseSubscription($input: pauseSubscriptionInput!) {
  pauseSubscription(input: $input) {
    message
    ok
  }
}
Variables
{"input": pauseSubscriptionInput}
Response
{
  "data": {
    "pauseSubscription": {
      "message": "abc123",
      "ok": false
    }
  }
}
Mutations

removeProductVariantFromSellingPlanGroup

Description

Remove a product variant from selling plan group

Response

Returns a removeProductVariantFromSellingPlanGroupOutput

Arguments
Name Description
input - removeProductVariantFromSellingPlanGroupInput!

Example

Query
mutation removeProductVariantFromSellingPlanGroup($input: removeProductVariantFromSellingPlanGroupInput!) {
  removeProductVariantFromSellingPlanGroup(input: $input) {
    ok
  }
}
Variables
{"input": removeProductVariantFromSellingPlanGroupInput}
Response
{"data": {"removeProductVariantFromSellingPlanGroup": {"ok": false}}}
Mutations

setDeliveryPriceOverride

Description

Force override sub delivery price and set flag (deliveryPriceOverride) so that the sub delivery price would not be affected by other resync actions anymore, unless explicity overwritten again.

Response

Returns a SetDeliveryPriceOverrideOutput

Arguments
Name Description
input - SetDeliveryPriceOverrideInput!

Example

Query
mutation setDeliveryPriceOverride($input: SetDeliveryPriceOverrideInput!) {
  setDeliveryPriceOverride(input: $input) {
    subscriptionId
  }
}
Variables
{"input": SetDeliveryPriceOverrideInput}
Response
{
  "data": {
    "setDeliveryPriceOverride": {"subscriptionId": uuid}
  }
}
Mutations

shipNow

Description

Creates a subscription order immediately

Response

Returns a ShipNowOutput

Arguments
Name Description
input - ShipNowInput!

Example

Query
mutation shipNow($input: ShipNowInput!) {
  shipNow(input: $input) {
    message
    ok
  }
}
Variables
{"input": ShipNowInput}
Response
{
  "data": {
    "shipNow": {
      "message": "xyz789",
      "ok": false
    }
  }
}
Mutations

subscriptionEditInterval

Response

Returns a SubscriptionEditIntervalOutput

Arguments
Name Description
input - SubscriptionEditIntervalInput!

Example

Query
mutation subscriptionEditInterval($input: SubscriptionEditIntervalInput!) {
  subscriptionEditInterval(input: $input) {
    subscriptionId
  }
}
Variables
{"input": SubscriptionEditIntervalInput}
Response
{
  "data": {
    "subscriptionEditInterval": {"subscriptionId": uuid}
  }
}
Mutations

subscriptionUpdatePaymentMethod

Response

Returns a SubscriptionUpdatePaymentMethodOutput

Arguments
Name Description
input - SubscriptionUpdatePaymentMethodInput!

Example

Query
mutation subscriptionUpdatePaymentMethod($input: SubscriptionUpdatePaymentMethodInput!) {
  subscriptionUpdatePaymentMethod(input: $input) {
    subscriptionId
  }
}
Variables
{"input": SubscriptionUpdatePaymentMethodInput}
Response
{
  "data": {
    "subscriptionUpdatePaymentMethod": {
      "subscriptionId": uuid
    }
  }
}
Mutations

swapSubscriptionProductVariants

Description

Swap product variants for a subscription.

Response

Returns a SwapSubscriptionProductVariantsOutput

Arguments
Name Description
input - SwapSubscriptionProductVariantsInput!

Example

Query
mutation swapSubscriptionProductVariants($input: SwapSubscriptionProductVariantsInput!) {
  swapSubscriptionProductVariants(input: $input) {
    ok
  }
}
Variables
{"input": SwapSubscriptionProductVariantsInput}
Response
{"data": {"swapSubscriptionProductVariants": {"ok": false}}}
Mutations

unpauseSubscription

Description

UnpauseSubscription

Response

Returns an unpauseSubscriptionOutput

Arguments
Name Description
input - unpauseSubscriptionInput!

Example

Query
mutation unpauseSubscription($input: unpauseSubscriptionInput!) {
  unpauseSubscription(input: $input) {
    message
    ok
  }
}
Variables
{"input": unpauseSubscriptionInput}
Response
{
  "data": {
    "unpauseSubscription": {
      "message": "xyz789",
      "ok": true
    }
  }
}
Mutations

updateDynamicBoxSubscription

Description

Update quantity and variants of child items in a dynamic box

Response

Returns an UpdateDynamicBoxSubscriptionOutput!

Arguments
Name Description
input - UpdateDynamicBoxSubscriptionInput!

Example

Query
mutation updateDynamicBoxSubscription($input: UpdateDynamicBoxSubscriptionInput!) {
  updateDynamicBoxSubscription(input: $input) {
    ok
  }
}
Variables
{"input": UpdateDynamicBoxSubscriptionInput}
Response
{"data": {"updateDynamicBoxSubscription": {"ok": true}}}
Mutations

updateNextBillingDate

Description

Change next billing date of a subscription. Date format should be an ISO string (YYYY-MM-DD), e.g 2022-01-01T17:44:49.406+00:00

Response

Returns an UpdateNextBillingDateOutput

Arguments
Name Description
input - UpdateNextBillingDateInput!

Example

Query
mutation updateNextBillingDate($input: UpdateNextBillingDateInput!) {
  updateNextBillingDate(input: $input) {
    message
    ok
  }
}
Variables
{"input": UpdateNextBillingDateInput}
Response
{
  "data": {
    "updateNextBillingDate": {
      "message": "xyz789",
      "ok": false
    }
  }
}
Mutations

updateSiteByPk

Description

update single row of the table: "Site"

Response

Returns a Site

Arguments
Name Description
_set - Site_set_input sets the columns of the filtered rows to the given values
pk_columns - Site_pk_columns_input!

Example

Query
mutation updateSiteByPk(
  $_set: Site_set_input,
  $pk_columns: Site_pk_columns_input!
) {
  updateSiteByPk(
    _set: $_set,
    pk_columns: $pk_columns
  ) {
    Holidays {
      ...HolidayFragment
    }
    Notifications {
      ...NotificationFragment
    }
    Products {
      ...ProductFragment
    }
    SkioSmsMessagingHistory {
      ...SkioSmsMessagingHistoryFragment
    }
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    Theme {
      ...ThemeFragment
    }
    Theme2 {
      ...Theme2Fragment
    }
    ianaTimezone
    id
    qaAuthSettings
  }
}
Variables
{
  "_set": Site_set_input,
  "pk_columns": Site_pk_columns_input
}
Response
{
  "data": {
    "updateSiteByPk": {
      "Holidays": [Holiday],
      "Notifications": [Notification],
      "Products": [Product],
      "SkioSmsMessagingHistory": [
        SkioSmsMessagingHistory
      ],
      "StorefrontUsers": [StorefrontUser],
      "Theme": Theme,
      "Theme2": Theme2,
      "ianaTimezone": "abc123",
      "id": uuid,
      "qaAuthSettings": jsonb
    }
  }
}
Mutations

updateSubscriptionLine

Description

Updates the subscription line (referenced by either a prepaidSubscriptionLineId or a subscriptionLineId) and changes quantity, price, or productVariant. IDs are Skio IDs. Quantity, price, and productVariant are optional, so only provide values for those you want to change.

Response

Returns an UpdateSubscriptionLineOutput

Arguments
Name Description
input - UpdateSubscriptionLineInput!

Example

Query
mutation updateSubscriptionLine($input: UpdateSubscriptionLineInput!) {
  updateSubscriptionLine(input: $input) {
    ok
  }
}
Variables
{"input": UpdateSubscriptionLineInput}
Response
{"data": {"updateSubscriptionLine": {"ok": false}}}
Mutations

updateSubscriptionNote

Description

updates a subscriptions note

Response

Returns an UpdateSubscriptionNoteOutput

Arguments
Name Description
input - UpdateSubscriptionNoteInput!

Example

Query
mutation updateSubscriptionNote($input: UpdateSubscriptionNoteInput!) {
  updateSubscriptionNote(input: $input) {
    note
    ok
  }
}
Variables
{"input": UpdateSubscriptionNoteInput}
Response
{
  "data": {
    "updateSubscriptionNote": {
      "note": "xyz789",
      "ok": false
    }
  }
}
Mutations

updateSubscriptionShippingAddress

Description

updates a subscriptions shipping address

Response

Returns an UpdateSubscriptionShippingAddressOutput

Arguments
Name Description
input - UpdateSubscriptionShippingAddressInput!

Example

Query
mutation updateSubscriptionShippingAddress($input: UpdateSubscriptionShippingAddressInput!) {
  updateSubscriptionShippingAddress(input: $input) {
    message
    ok
  }
}
Variables
{"input": UpdateSubscriptionShippingAddressInput}
Response
{
  "data": {
    "updateSubscriptionShippingAddress": {
      "message": "xyz789",
      "ok": false
    }
  }
}

Types

AddSubscriptionLineInput

Fields
Input Field Description
customAttributes - jsonb
price - Float
quantity - Int
subscriptionId - uuid!
upsell - Boolean
variantId - uuid!
Example
{
  "customAttributes": jsonb,
  "price": 987.65,
  "quantity": 123,
  "subscriptionId": uuid,
  "upsell": false,
  "variantId": uuid
}
Types

AddSubscriptionLineOutput

Fields
Field Name Description
ok - Boolean!
Example
{"ok": true}
Types

Address

Description

first/last nullable for billing fields

Fields
Field Name Description
PaymentMethod - PaymentMethod An object relationship
StorefrontUser - StorefrontUser! An object relationship
Subscriptions - [Subscription!]! An array relationship
address1 - String
address2 - String
city - String
company - String
country - String
createdAt - timestamptz!
doorCode - String
firstName - String
id - uuid!
lastName - String
phoneNumber - String
platformId - String
province - String
storefrontUserId - uuid!
updatedAt - timestamptz!
zip - String
Example
{
  "PaymentMethod": PaymentMethod,
  "StorefrontUser": StorefrontUser,
  "Subscriptions": [Subscription],
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "xyz789",
  "company": "xyz789",
  "country": "xyz789",
  "createdAt": timestamptz,
  "doorCode": "abc123",
  "firstName": "xyz789",
  "id": uuid,
  "lastName": "xyz789",
  "phoneNumber": "xyz789",
  "platformId": "xyz789",
  "province": "xyz789",
  "storefrontUserId": uuid,
  "updatedAt": timestamptz,
  "zip": "xyz789"
}
Types

Address_aggregate_order_by

Description

order by aggregate values of table "Address"

Fields
Input Field Description
count - order_by
max - Address_max_order_by
min - Address_min_order_by
Example
{
  "count": "asc",
  "max": Address_max_order_by,
  "min": Address_min_order_by
}
Types

Address_bool_exp

Description

Boolean expression to filter rows from the table "Address". All fields are combined with a logical 'AND'.

Fields
Input Field Description
PaymentMethod - PaymentMethod_bool_exp
StorefrontUser - StorefrontUser_bool_exp
Subscriptions - Subscription_bool_exp
_and - [Address_bool_exp!]
_not - Address_bool_exp
_or - [Address_bool_exp!]
address1 - String_comparison_exp
address2 - String_comparison_exp
city - String_comparison_exp
company - String_comparison_exp
country - String_comparison_exp
createdAt - timestamptz_comparison_exp
doorCode - String_comparison_exp
firstName - String_comparison_exp
id - uuid_comparison_exp
lastName - String_comparison_exp
phoneNumber - String_comparison_exp
platformId - String_comparison_exp
province - String_comparison_exp
storefrontUserId - uuid_comparison_exp
updatedAt - timestamptz_comparison_exp
zip - String_comparison_exp
Example
{
  "PaymentMethod": PaymentMethod_bool_exp,
  "StorefrontUser": StorefrontUser_bool_exp,
  "Subscriptions": Subscription_bool_exp,
  "_and": [Address_bool_exp],
  "_not": Address_bool_exp,
  "_or": [Address_bool_exp],
  "address1": String_comparison_exp,
  "address2": String_comparison_exp,
  "city": String_comparison_exp,
  "company": String_comparison_exp,
  "country": String_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "doorCode": String_comparison_exp,
  "firstName": String_comparison_exp,
  "id": uuid_comparison_exp,
  "lastName": String_comparison_exp,
  "phoneNumber": String_comparison_exp,
  "platformId": String_comparison_exp,
  "province": String_comparison_exp,
  "storefrontUserId": uuid_comparison_exp,
  "updatedAt": timestamptz_comparison_exp,
  "zip": String_comparison_exp
}
Types

Address_max_order_by

Description

order by max() on columns of table "Address"

Fields
Input Field Description
address1 - order_by
address2 - order_by
city - order_by
company - order_by
country - order_by
createdAt - order_by
doorCode - order_by
firstName - order_by
id - order_by
lastName - order_by
phoneNumber - order_by
platformId - order_by
province - order_by
storefrontUserId - order_by
updatedAt - order_by
zip - order_by
Example
{
  "address1": "asc",
  "address2": "asc",
  "city": "asc",
  "company": "asc",
  "country": "asc",
  "createdAt": "asc",
  "doorCode": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "province": "asc",
  "storefrontUserId": "asc",
  "updatedAt": "asc",
  "zip": "asc"
}
Types

Address_min_order_by

Description

order by min() on columns of table "Address"

Fields
Input Field Description
address1 - order_by
address2 - order_by
city - order_by
company - order_by
country - order_by
createdAt - order_by
doorCode - order_by
firstName - order_by
id - order_by
lastName - order_by
phoneNumber - order_by
platformId - order_by
province - order_by
storefrontUserId - order_by
updatedAt - order_by
zip - order_by
Example
{
  "address1": "asc",
  "address2": "asc",
  "city": "asc",
  "company": "asc",
  "country": "asc",
  "createdAt": "asc",
  "doorCode": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "province": "asc",
  "storefrontUserId": "asc",
  "updatedAt": "asc",
  "zip": "asc"
}
Types

Address_order_by

Description

Ordering options when selecting data from "Address".

Fields
Input Field Description
PaymentMethod - PaymentMethod_order_by
StorefrontUser - StorefrontUser_order_by
Subscriptions_aggregate - Subscription_aggregate_order_by
address1 - order_by
address2 - order_by
city - order_by
company - order_by
country - order_by
createdAt - order_by
doorCode - order_by
firstName - order_by
id - order_by
lastName - order_by
phoneNumber - order_by
platformId - order_by
province - order_by
storefrontUserId - order_by
updatedAt - order_by
zip - order_by
Example
{
  "PaymentMethod": PaymentMethod_order_by,
  "StorefrontUser": StorefrontUser_order_by,
  "Subscriptions_aggregate": Subscription_aggregate_order_by,
  "address1": "asc",
  "address2": "asc",
  "city": "asc",
  "company": "asc",
  "country": "asc",
  "createdAt": "asc",
  "doorCode": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "province": "asc",
  "storefrontUserId": "asc",
  "updatedAt": "asc",
  "zip": "asc"
}
Types

Address_select_column

Description

select columns of table "Address"

Values
Enum Value Description

address1

 column name

address2

 column name

city

 column name

company

 column name

country

 column name

createdAt

 column name

doorCode

 column name

firstName

 column name

id

 column name

lastName

 column name

phoneNumber

 column name

platformId

 column name

province

 column name

storefrontUserId

 column name

updatedAt

 column name

zip

 column name
Example
"address1"
Types

Anchor

Description

storefront user select/insert/update kinda funny. select is for seeing all anchor types (I think?!) and insert/update for modifying date

Fields
Field Name Description
Policy - Policy! An object relationship
createdAt - timestamptz!
cutoffDay - Int
day - Int!
id - uuid!
missedAnchorAllowance - Int
month - Int
policyId - uuid!
strictness - String!
type - String!
updatedAt - timestamptz!
Example
{
  "Policy": Policy,
  "createdAt": timestamptz,
  "cutoffDay": 123,
  "day": 123,
  "id": uuid,
  "missedAnchorAllowance": 123,
  "month": 123,
  "policyId": uuid,
  "strictness": "xyz789",
  "type": "xyz789",
  "updatedAt": timestamptz
}
Types

Anchor_aggregate_order_by

Description

order by aggregate values of table "Anchor"

Fields
Input Field Description
avg - Anchor_avg_order_by
count - order_by
max - Anchor_max_order_by
min - Anchor_min_order_by
stddev - Anchor_stddev_order_by
stddev_pop - Anchor_stddev_pop_order_by
stddev_samp - Anchor_stddev_samp_order_by
sum - Anchor_sum_order_by
var_pop - Anchor_var_pop_order_by
var_samp - Anchor_var_samp_order_by
variance - Anchor_variance_order_by
Example
{
  "avg": Anchor_avg_order_by,
  "count": "asc",
  "max": Anchor_max_order_by,
  "min": Anchor_min_order_by,
  "stddev": Anchor_stddev_order_by,
  "stddev_pop": Anchor_stddev_pop_order_by,
  "stddev_samp": Anchor_stddev_samp_order_by,
  "sum": Anchor_sum_order_by,
  "var_pop": Anchor_var_pop_order_by,
  "var_samp": Anchor_var_samp_order_by,
  "variance": Anchor_variance_order_by
}
Types

Anchor_avg_order_by

Description

order by avg() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_bool_exp

Description

Boolean expression to filter rows from the table "Anchor". All fields are combined with a logical 'AND'.

Fields
Input Field Description
Policy - Policy_bool_exp
_and - [Anchor_bool_exp!]
_not - Anchor_bool_exp
_or - [Anchor_bool_exp!]
createdAt - timestamptz_comparison_exp
cutoffDay - Int_comparison_exp
day - Int_comparison_exp
id - uuid_comparison_exp
missedAnchorAllowance - Int_comparison_exp
month - Int_comparison_exp
policyId - uuid_comparison_exp
strictness - String_comparison_exp
type - String_comparison_exp
updatedAt - timestamptz_comparison_exp
Example
{
  "Policy": Policy_bool_exp,
  "_and": [Anchor_bool_exp],
  "_not": Anchor_bool_exp,
  "_or": [Anchor_bool_exp],
  "createdAt": timestamptz_comparison_exp,
  "cutoffDay": Int_comparison_exp,
  "day": Int_comparison_exp,
  "id": uuid_comparison_exp,
  "missedAnchorAllowance": Int_comparison_exp,
  "month": Int_comparison_exp,
  "policyId": uuid_comparison_exp,
  "strictness": String_comparison_exp,
  "type": String_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
Types

Anchor_max_order_by

Description

order by max() on columns of table "Anchor"

Fields
Input Field Description
createdAt - order_by
cutoffDay - order_by
day - order_by
id - order_by
missedAnchorAllowance - order_by
month - order_by
policyId - order_by
strictness - order_by
type - order_by
updatedAt - order_by
Example
{
  "createdAt": "asc",
  "cutoffDay": "asc",
  "day": "asc",
  "id": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc",
  "policyId": "asc",
  "strictness": "asc",
  "type": "asc",
  "updatedAt": "asc"
}
Types

Anchor_min_order_by

Description

order by min() on columns of table "Anchor"

Fields
Input Field Description
createdAt - order_by
cutoffDay - order_by
day - order_by
id - order_by
missedAnchorAllowance - order_by
month - order_by
policyId - order_by
strictness - order_by
type - order_by
updatedAt - order_by
Example
{
  "createdAt": "asc",
  "cutoffDay": "asc",
  "day": "asc",
  "id": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc",
  "policyId": "asc",
  "strictness": "asc",
  "type": "asc",
  "updatedAt": "asc"
}
Types

Anchor_stddev_order_by

Description

order by stddev() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_stddev_pop_order_by

Description

order by stddev_pop() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_stddev_samp_order_by

Description

order by stddev_samp() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_sum_order_by

Description

order by sum() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_var_pop_order_by

Description

order by var_pop() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_var_samp_order_by

Description

order by var_samp() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

Anchor_variance_order_by

Description

order by variance() on columns of table "Anchor"

Fields
Input Field Description
cutoffDay - order_by
day - order_by
missedAnchorAllowance - order_by
month - order_by
Example
{
  "cutoffDay": "asc",
  "day": "asc",
  "missedAnchorAllowance": "asc",
  "month": "asc"
}
Types

ApplyDiscountCodeInput

Fields
Input Field Description
code - String!
subscriptionId - uuid!
Example
{
  "code": "xyz789",
  "subscriptionId": uuid
}
Types

ApplyDiscountCodeOutput

Fields
Field Name Description
message - String!
ok - Boolean!
Example
{"message": "xyz789", "ok": false}
Types

AuditLog

Description

columns and relationships of "AuditLog"

Fields
Field Name Description
StorefrontUser - StorefrontUser An object relationship
Subscription - Subscription An object relationship
createdAt - timestamptz!
eventData - jsonb!
eventType - String!
id - uuid!
storefrontUserId - uuid
subscriptionId - uuid
updatedAt - timestamptz!
Example
{
  "StorefrontUser": StorefrontUser,
  "Subscription": Subscription,
  "createdAt": timestamptz,
  "eventData": jsonb,
  "eventType": "abc123",
  "id": uuid,
  "storefrontUserId": uuid,
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}
Types

AuditLog_aggregate_order_by

Description

order by aggregate values of table "AuditLog"

Fields
Input Field Description
count - order_by
max - AuditLog_max_order_by
min - AuditLog_min_order_by
Example
{
  "count": "asc",
  "max": AuditLog_max_order_by,
  "min": AuditLog_min_order_by
}
Types

AuditLog_bool_exp

Description

Boolean expression to filter rows from the table "AuditLog". All fields are combined with a logical 'AND'.

Fields
Input Field Description
StorefrontUser - StorefrontUser_bool_exp
Subscription - Subscription_bool_exp
_and - [AuditLog_bool_exp!]
_not - AuditLog_bool_exp
_or - [AuditLog_bool_exp!]
createdAt - timestamptz_comparison_exp
eventData - jsonb_comparison_exp
eventType - String_comparison_exp
id - uuid_comparison_exp
storefrontUserId - uuid_comparison_exp
subscriptionId - uuid_comparison_exp
updatedAt - timestamptz_comparison_exp
Example
{
  "StorefrontUser": StorefrontUser_bool_exp,
  "Subscription": Subscription_bool_exp,
  "_and": [AuditLog_bool_exp],
  "_not": AuditLog_bool_exp,
  "_or": [AuditLog_bool_exp],
  "createdAt": timestamptz_comparison_exp,
  "eventData": jsonb_comparison_exp,
  "eventType": String_comparison_exp,
  "id": uuid_comparison_exp,
  "storefrontUserId": uuid_comparison_exp,
  "subscriptionId": uuid_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
Types

AuditLog_max_order_by

Description

order by max() on columns of table "AuditLog"

Fields
Input Field Description
createdAt - order_by
eventType - order_by
id - order_by
storefrontUserId - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "createdAt": "asc",
  "eventType": "asc",
  "id": "asc",
  "storefrontUserId": "asc",
  "subscriptionId": "asc",
  "updatedAt": "asc"
}
Types

AuditLog_min_order_by

Description

order by min() on columns of table "AuditLog"

Fields
Input Field Description
createdAt - order_by
eventType - order_by
id - order_by
storefrontUserId - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "createdAt": "asc",
  "eventType": "asc",
  "id": "asc",
  "storefrontUserId": "asc",
  "subscriptionId": "asc",
  "updatedAt": "asc"
}
Types

BillingAttempt_bool_exp

Description

Boolean expression to filter rows from the table "BillingAttempt". All fields are combined with a logical 'AND'.

Fields
Input Field Description
Subscription - Subscription_bool_exp
_and - [BillingAttempt_bool_exp!]
_not - BillingAttempt_bool_exp
_or - [BillingAttempt_bool_exp!]
billingAttemptedAt - timestamptz_comparison_exp
createdAt - timestamptz_comparison_exp
errorCode - String_comparison_exp
errorMessage - String_comparison_exp
id - uuid_comparison_exp
orderPlatformId - String_comparison_exp
platformId - String_comparison_exp
subscriptionBillingDate - timestamptz_comparison_exp
subscriptionId - uuid_comparison_exp
updatedAt - timestamptz_comparison_exp
Example
{
  "Subscription": Subscription_bool_exp,
  "_and": [BillingAttempt_bool_exp],
  "_not": BillingAttempt_bool_exp,
  "_or": [BillingAttempt_bool_exp],
  "billingAttemptedAt": timestamptz_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "errorCode": String_comparison_exp,
  "errorMessage": String_comparison_exp,
  "id": uuid_comparison_exp,
  "orderPlatformId": String_comparison_exp,
  "platformId": String_comparison_exp,
  "subscriptionBillingDate": timestamptz_comparison_exp,
  "subscriptionId": uuid_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
Types

Boolean

Types

Boolean_comparison_exp

Description

Boolean expression to compare columns of type "Boolean". All fields are combined with logical 'AND'.

Fields
Input Field Description
_eq - Boolean
_gt - Boolean
_gte - Boolean
_in - [Boolean!]
_is_null - Boolean
_lt - Boolean
_lte - Boolean
_neq - Boolean
_nin - [Boolean!]
Example
{
  "_eq": false,
  "_gt": false,
  "_gte": false,
  "_in": [false],
  "_is_null": true,
  "_lt": true,
  "_lte": false,
  "_neq": false,
  "_nin": [false]
}
Types

CancelFlowReason

Description

This table is no longer used. Look at CancelFlowV2Reason instead

Fields
Field Name Description
CancelFlowSession - CancelFlowSession An object relationship
cancelFlowId - uuid!
cancelFlowSessionId - uuid
createdAt - timestamptz!
id - uuid!
order - numeric!
otherReasonBody - String
reason - String!
rebuttal - String
updatedAt - timestamptz!
Example
{
  "CancelFlowSession": CancelFlowSession,
  "cancelFlowId": uuid,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "id": uuid,
  "order": numeric,
  "otherReasonBody": "xyz789",
  "reason": "abc123",
  "rebuttal": "abc123",
  "updatedAt": timestamptz
}
Types

CancelFlowReason_bool_exp

Description

Boolean expression to filter rows from the table "CancelFlowReason". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowSession - CancelFlowSession_bool_exp
_and - [CancelFlowReason_bool_exp!]
_not - CancelFlowReason_bool_exp
_or - [CancelFlowReason_bool_exp!]
cancelFlowId - uuid_comparison_exp
cancelFlowSessionId - uuid_comparison_exp
createdAt - timestamptz_comparison_exp
id - uuid_comparison_exp
order - numeric_comparison_exp
otherReasonBody - String_comparison_exp
reason - String_comparison_exp
rebuttal - String_comparison_exp
updatedAt - timestamptz_comparison_exp
Example
{
  "CancelFlowSession": CancelFlowSession_bool_exp,
  "_and": [CancelFlowReason_bool_exp],
  "_not": CancelFlowReason_bool_exp,
  "_or": [CancelFlowReason_bool_exp],
  "cancelFlowId": uuid_comparison_exp,
  "cancelFlowSessionId": uuid_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "order": numeric_comparison_exp,
  "otherReasonBody": String_comparison_exp,
  "reason": String_comparison_exp,
  "rebuttal": String_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
Types

CancelFlowReason_order_by

Description

Ordering options when selecting data from "CancelFlowReason".

Fields
Input Field Description
CancelFlowSession - CancelFlowSession_order_by
cancelFlowId - order_by
cancelFlowSessionId - order_by
createdAt - order_by
id - order_by
order - order_by
otherReasonBody - order_by
reason - order_by
rebuttal - order_by
updatedAt - order_by
Example
{
  "CancelFlowSession": CancelFlowSession_order_by,
  "cancelFlowId": "asc",
  "cancelFlowSessionId": "asc",
  "createdAt": "asc",
  "id": "asc",
  "order": "asc",
  "otherReasonBody": "asc",
  "reason": "asc",
  "rebuttal": "asc",
  "updatedAt": "asc"
}
Types

CancelFlowSession

Description

This table is no longer used. Look at CancelFlowV2Session

Fields
Field Name Description
CancelFlowReason - CancelFlowReason An object relationship
Discounts - [Discount!]! An array relationship
Subscription - Subscription! An object relationship
cancelFlowId - uuid!
createdAt - timestamptz!
id - uuid!
status - String
subscriptionId - uuid!
updatedAt - timestamptz!
Example
{
  "CancelFlowReason": CancelFlowReason,
  "Discounts": [Discount],
  "Subscription": Subscription,
  "cancelFlowId": uuid,
  "createdAt": timestamptz,
  "id": uuid,
  "status": "abc123",
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}
Types

CancelFlowSession_aggregate_order_by

Description

order by aggregate values of table "CancelFlowSession"

Fields
Input Field Description
count - order_by
max - CancelFlowSession_max_order_by
min - CancelFlowSession_min_order_by
Example
{
  "count": "asc",
  "max": CancelFlowSession_max_order_by,
  "min": CancelFlowSession_min_order_by
}
Types

CancelFlowSession_bool_exp

Description

Boolean expression to filter rows from the table "CancelFlowSession". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowReason - CancelFlowReason_bool_exp
Discounts - Discount_bool_exp
Subscription - Subscription_bool_exp
_and - [CancelFlowSession_bool_exp!]
_not - CancelFlowSession_bool_exp
_or - [CancelFlowSession_bool_exp!]
cancelFlowId - uuid_comparison_exp
createdAt - timestamptz_comparison_exp
id - uuid_comparison_exp
status - String_comparison_exp
subscriptionId - uuid_comparison_exp
updatedAt - timestamptz_comparison_exp
Example
{
  "CancelFlowReason": CancelFlowReason_bool_exp,
  "Discounts": Discount_bool_exp,
  "Subscription": Subscription_bool_exp,
  "_and": [CancelFlowSession_bool_exp],
  "_not": CancelFlowSession_bool_exp,
  "_or": [CancelFlowSession_bool_exp],
  "cancelFlowId": uuid_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "status": String_comparison_exp,
  "subscriptionId": uuid_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
Types

CancelFlowSession_max_order_by

Description

order by max() on columns of table "CancelFlowSession"

Fields
Input Field Description
cancelFlowId - order_by
createdAt - order_by
id - order_by
status - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "cancelFlowId": "asc",
  "createdAt": "asc",
  "id": "asc",
  "status": "asc",
  "subscriptionId": "asc",
  "updatedAt": "asc"
}
Types

CancelFlowSession_min_order_by

Description

order by min() on columns of table "CancelFlowSession"

Fields
Input Field Description
cancelFlowId - order_by
createdAt - order_by
id - order_by
status - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "cancelFlowId": "asc",
  "createdAt": "asc",
  "id": "asc",
  "status": "asc",
  "subscriptionId": "asc",
  "updatedAt": "asc"
}
Types

CancelFlowSession_order_by

Description

Ordering options when selecting data from "CancelFlowSession".

Fields
Input Field Description
CancelFlowReason - CancelFlowReason_order_by
Discounts_aggregate - Discount_aggregate_order_by
Subscription - Subscription_order_by
cancelFlowId - order_by
createdAt - order_by
id - order_by
status - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "CancelFlowReason": CancelFlowReason_order_by,
  "Discounts_aggregate": Discount_aggregate_order_by,
  "Subscription": Subscription_order_by,
  "cancelFlowId": "asc",
  "createdAt": "asc",
  "id": "asc",
  "status": "asc",
  "subscriptionId": "asc",
  "updatedAt": "asc"
}
Types

CancelFlowV2Reason

Description

Explanations for fields can be found here https://www.notion.so/CancelFlowV2Reason-Schema-497069ec1c1e4ef1ac6b90e917cc84f7?pvs=4

Fields
Field Name Description
CancelFlowV2Rebuttals - [CancelFlowV2Rebuttal!]! An array relationship
cancelFlowId - uuid!
childrenReasonIds - jsonb
created_at - timestamptz!
enableCustomerInput - Boolean!
enabled - Boolean!
id - uuid!
isMultipleActions - Boolean!
parentReasonId - uuid
reason - String!
removed_at - timestamptz
updated_at - timestamptz!
Example
{
  "CancelFlowV2Rebuttals": [CancelFlowV2Rebuttal],
  "cancelFlowId": uuid,
  "childrenReasonIds": jsonb,
  "created_at": timestamptz,
  "enableCustomerInput": false,
  "enabled": true,
  "id": uuid,
  "isMultipleActions": false,
  "parentReasonId": uuid,
  "reason": "abc123",
  "removed_at": timestamptz,
  "updated_at": timestamptz
}
Types

CancelFlowV2Reason_bool_exp

Description

Boolean expression to filter rows from the table "CancelFlowV2Reason". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowV2Rebuttals - CancelFlowV2Rebuttal_bool_exp
_and - [CancelFlowV2Reason_bool_exp!]
_not - CancelFlowV2Reason_bool_exp
_or - [CancelFlowV2Reason_bool_exp!]
cancelFlowId - uuid_comparison_exp
childrenReasonIds - jsonb_comparison_exp
created_at - timestamptz_comparison_exp
enableCustomerInput - Boolean_comparison_exp
enabled - Boolean_comparison_exp
id - uuid_comparison_exp
isMultipleActions - Boolean_comparison_exp
parentReasonId - uuid_comparison_exp
reason - String_comparison_exp
removed_at - timestamptz_comparison_exp
updated_at - timestamptz_comparison_exp
Example
{
  "CancelFlowV2Rebuttals": CancelFlowV2Rebuttal_bool_exp,
  "_and": [CancelFlowV2Reason_bool_exp],
  "_not": CancelFlowV2Reason_bool_exp,
  "_or": [CancelFlowV2Reason_bool_exp],
  "cancelFlowId": uuid_comparison_exp,
  "childrenReasonIds": jsonb_comparison_exp,
  "created_at": timestamptz_comparison_exp,
  "enableCustomerInput": Boolean_comparison_exp,
  "enabled": Boolean_comparison_exp,
  "id": uuid_comparison_exp,
  "isMultipleActions": Boolean_comparison_exp,
  "parentReasonId": uuid_comparison_exp,
  "reason": String_comparison_exp,
  "removed_at": timestamptz_comparison_exp,
  "updated_at": timestamptz_comparison_exp
}
Types

CancelFlowV2Rebuttal

Description

Explanations for fields can be found here. https://www.notion.so/CancelFlowV2Rebuttal-Schema-3dd686bbd2e0426da6415d749f265b12?pvs=4

Fields
Field Name Description
CancelFlowV2Reason - CancelFlowV2Reason An object relationship
action - String!
actions - jsonb
cancelFlowReasonId - uuid
condition - jsonb
conditionsV2 - jsonb
created_at - timestamptz!
enabled - Boolean!
id - uuid!
isRebuttalURL - Boolean!
nextRebuttalId - uuid
options - jsonb
parentRebuttalId - uuid
rebuttal - String!
rebuttalMediaUrl - String
removed_at - timestamptz
updated_at - timestamptz!
Example
{
  "CancelFlowV2Reason": CancelFlowV2Reason,
  "action": "xyz789",
  "actions": jsonb,
  "cancelFlowReasonId": uuid,
  "condition": jsonb,
  "conditionsV2": jsonb,
  "created_at": timestamptz,
  "enabled": false,
  "id": uuid,
  "isRebuttalURL": false,
  "nextRebuttalId": uuid,
  "options": jsonb,
  "parentRebuttalId": uuid,
  "rebuttal": "abc123",
  "rebuttalMediaUrl": "xyz789",
  "removed_at": timestamptz,
  "updated_at": timestamptz
}
Types

CancelFlowV2Rebuttal_bool_exp

Description

Boolean expression to filter rows from the table "CancelFlowV2Rebuttal". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowV2Reason - CancelFlowV2Reason_bool_exp
_and - [CancelFlowV2Rebuttal_bool_exp!]
_not - CancelFlowV2Rebuttal_bool_exp
_or - [CancelFlowV2Rebuttal_bool_exp!]
action - String_comparison_exp
actions - jsonb_comparison_exp
cancelFlowReasonId - uuid_comparison_exp
condition - jsonb_comparison_exp
conditionsV2 - jsonb_comparison_exp
created_at - timestamptz_comparison_exp
enabled - Boolean_comparison_exp
id - uuid_comparison_exp
isRebuttalURL - Boolean_comparison_exp
nextRebuttalId - uuid_comparison_exp
options - jsonb_comparison_exp
parentRebuttalId - uuid_comparison_exp
rebuttal - String_comparison_exp
rebuttalMediaUrl - String_comparison_exp
removed_at - timestamptz_comparison_exp
updated_at - timestamptz_comparison_exp
Example
{
  "CancelFlowV2Reason": CancelFlowV2Reason_bool_exp,
  "_and": [CancelFlowV2Rebuttal_bool_exp],
  "_not": CancelFlowV2Rebuttal_bool_exp,
  "_or": [CancelFlowV2Rebuttal_bool_exp],
  "action": String_comparison_exp,
  "actions": jsonb_comparison_exp,
  "cancelFlowReasonId": uuid_comparison_exp,
  "condition": jsonb_comparison_exp,
  "conditionsV2": jsonb_comparison_exp,
  "created_at": timestamptz_comparison_exp,
  "enabled": Boolean_comparison_exp,
  "id": uuid_comparison_exp,
  "isRebuttalURL": Boolean_comparison_exp,
  "nextRebuttalId": uuid_comparison_exp,
  "options": jsonb_comparison_exp,
  "parentRebuttalId": uuid_comparison_exp,
  "rebuttal": String_comparison_exp,
  "rebuttalMediaUrl": String_comparison_exp,
  "removed_at": timestamptz_comparison_exp,
  "updated_at": timestamptz_comparison_exp
}
Types

CancelFlowV2Session

Description

Explanation for fields can be found here https://www.notion.so/CancelFlowV2Session-Schema-49caa9d13ff14bf9b2d029e9512379eb?pvs=4

Fields
Field Name Description
CancelFlowSession - CancelFlowSession An object relationship
Site - Site An object relationship
Subscription - Subscription! An object relationship
action - String
actions - jsonb
actionsV2 - jsonb
actionsV2MultiStep - jsonb
cancelFlowId - uuid!
conditions - jsonb
conditionsV2 - jsonb
created_at - timestamptz!
id - uuid!
isMultipleActions - Boolean!
isOtherReason - Boolean!
isSplashScreen - Boolean
reason - String
reasonPath - jsonb
rebuttal - String
rebuttalOptions - jsonb
shownActions - jsonb
shownReasons - jsonb
shownRebuttals - jsonb
siteId - uuid
status - String
subscriptionId - uuid!
updated_at - timestamptz!
Example
{
  "CancelFlowSession": CancelFlowSession,
  "Site": Site,
  "Subscription": Subscription,
  "action": "abc123",
  "actions": jsonb,
  "actionsV2": jsonb,
  "actionsV2MultiStep": jsonb,
  "cancelFlowId": uuid,
  "conditions": jsonb,
  "conditionsV2": jsonb,
  "created_at": timestamptz,
  "id": uuid,
  "isMultipleActions": true,
  "isOtherReason": false,
  "isSplashScreen": false,
  "reason": "xyz789",
  "reasonPath": jsonb,
  "rebuttal": "xyz789",
  "rebuttalOptions": jsonb,
  "shownActions": jsonb,
  "shownReasons": jsonb,
  "shownRebuttals": jsonb,
  "siteId": uuid,
  "status": "abc123",
  "subscriptionId": uuid,
  "updated_at": timestamptz
}
Types

CancelFlowV2Session_aggregate_order_by

Description

order by aggregate values of table "CancelFlowV2Session"

Fields
Input Field Description
count - order_by
max - CancelFlowV2Session_max_order_by
min - CancelFlowV2Session_min_order_by
Example
{
  "count": "asc",
  "max": CancelFlowV2Session_max_order_by,
  "min": CancelFlowV2Session_min_order_by
}
Types

CancelFlowV2Session_bool_exp

Description

Boolean expression to filter rows from the table "CancelFlowV2Session". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowSession - CancelFlowSession_bool_exp
Site - Site_bool_exp
Subscription - Subscription_bool_exp
_and - [CancelFlowV2Session_bool_exp!]
_not - CancelFlowV2Session_bool_exp
_or - [CancelFlowV2Session_bool_exp!]
action - String_comparison_exp
actions - jsonb_comparison_exp
actionsV2 - jsonb_comparison_exp
actionsV2MultiStep - jsonb_comparison_exp
cancelFlowId - uuid_comparison_exp
conditions - jsonb_comparison_exp
conditionsV2 - jsonb_comparison_exp
created_at - timestamptz_comparison_exp
id - uuid_comparison_exp
isMultipleActions - Boolean_comparison_exp
isOtherReason - Boolean_comparison_exp
isSplashScreen - Boolean_comparison_exp
reason - String_comparison_exp
reasonPath - jsonb_comparison_exp
rebuttal - String_comparison_exp
rebuttalOptions - jsonb_comparison_exp
shownActions - jsonb_comparison_exp
shownReasons - jsonb_comparison_exp
shownRebuttals - jsonb_comparison_exp
siteId - uuid_comparison_exp
status - String_comparison_exp
subscriptionId - uuid_comparison_exp
updated_at - timestamptz_comparison_exp
Example
{
  "CancelFlowSession": CancelFlowSession_bool_exp,
  "Site": Site_bool_exp,
  "Subscription": Subscription_bool_exp,
  "_and": [CancelFlowV2Session_bool_exp],
  "_not": CancelFlowV2Session_bool_exp,
  "_or": [CancelFlowV2Session_bool_exp],
  "action": String_comparison_exp,
  "actions": jsonb_comparison_exp,
  "actionsV2": jsonb_comparison_exp,
  "actionsV2MultiStep": jsonb_comparison_exp,
  "cancelFlowId": uuid_comparison_exp,
  "conditions": jsonb_comparison_exp,
  "conditionsV2": jsonb_comparison_exp,
  "created_at": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "isMultipleActions": Boolean_comparison_exp,
  "isOtherReason": Boolean_comparison_exp,
  "isSplashScreen": Boolean_comparison_exp,
  "reason": String_comparison_exp,
  "reasonPath": jsonb_comparison_exp,
  "rebuttal": String_comparison_exp,
  "rebuttalOptions": jsonb_comparison_exp,
  "shownActions": jsonb_comparison_exp,
  "shownReasons": jsonb_comparison_exp,
  "shownRebuttals": jsonb_comparison_exp,
  "siteId": uuid_comparison_exp,
  "status": String_comparison_exp,
  "subscriptionId": uuid_comparison_exp,
  "updated_at": timestamptz_comparison_exp
}
Types

CancelFlowV2Session_max_order_by

Description

order by max() on columns of table "CancelFlowV2Session"

Fields
Input Field Description
action - order_by
cancelFlowId - order_by
created_at - order_by
id - order_by
reason - order_by
rebuttal - order_by
siteId - order_by
status - order_by
subscriptionId - order_by
updated_at - order_by
Example
{
  "action": "asc",
  "cancelFlowId": "asc",
  "created_at": "asc",
  "id": "asc",
  "reason": "asc",
  "rebuttal": "asc",
  "siteId": "asc",
  "status": "asc",
  "subscriptionId": "asc",
  "updated_at": "asc"
}
Types

CancelFlowV2Session_min_order_by

Description

order by min() on columns of table "CancelFlowV2Session"

Fields
Input Field Description
action - order_by
cancelFlowId - order_by
created_at - order_by
id - order_by
reason - order_by
rebuttal - order_by
siteId - order_by
status - order_by
subscriptionId - order_by
updated_at - order_by
Example
{
  "action": "asc",
  "cancelFlowId": "asc",
  "created_at": "asc",
  "id": "asc",
  "reason": "asc",
  "rebuttal": "asc",
  "siteId": "asc",
  "status": "asc",
  "subscriptionId": "asc",
  "updated_at": "asc"
}
Types

CancelSubscriptionInput

Fields
Input Field Description
cancelSessionId - String
permanentlyCancel - Boolean
shouldSendNotif - Boolean
subscriptionId - uuid!
Example
{
  "cancelSessionId": "xyz789",
  "permanentlyCancel": false,
  "shouldSendNotif": true,
  "subscriptionId": uuid
}
Types

CancelSubscriptionOutput

Fields
Field Name Description
ok - Boolean!
Example
{"ok": false}
Types

CreateSubscriptionCustomAttribute

Fields
Input Field Description
key - String!
value - String
Example
{
  "key": "xyz789",
  "value": "abc123"
}
Types

CreateSubscriptionInput

Fields
Input Field Description
addressId - uuid!
billingPolicyInfo - CreateSubscriptionPolicyInfo!
customAttributes - [CreateSubscriptionCustomAttribute!]
discountCode - String
nextBillingDate - String
paymentMethodId - uuid!
prepaidPolicyInfo - CreateSubscriptionPolicyInfo
storefrontUserId - uuid!
subscriptionLines - [CreateSubscriptionLine!]!
subscriptionType - CreateSubscriptionType!
Example
{
  "addressId": uuid,
  "billingPolicyInfo": CreateSubscriptionPolicyInfo,
  "customAttributes": [CreateSubscriptionCustomAttribute],
  "discountCode": "abc123",
  "nextBillingDate": "abc123",
  "paymentMethodId": uuid,
  "prepaidPolicyInfo": CreateSubscriptionPolicyInfo,
  "storefrontUserId": uuid,
  "subscriptionLines": [CreateSubscriptionLine],
  "subscriptionType": "PREPAID"
}
Types

CreateSubscriptionLine

Fields
Input Field Description
price - Float
quantity - Int!
variantId - uuid!
Example
{"price": 123.45, "quantity": 123, "variantId": uuid}
Types

CreateSubscriptionOutput

Fields
Field Name Description
id - uuid!
platformId - String
Example
{
  "id": uuid,
  "platformId": "abc123"
}
Types

CreateSubscriptionPolicyInfo

Fields
Input Field Description
interval - SellingPlanIntervalEnum!
intervalCount - Int!
Example
{"interval": "DAY", "intervalCount": 123}
Types

CreateSubscriptionType

Values
Enum Value Description

PREPAID

SUBSCRIBE_AND_SAVE
Example
"PREPAID"
Types

Discount

Description

We stick the objects on here since we want to be able to point multiple discounts at them.

Fields
Field Name Description
CancelFlowSession - CancelFlowSession An object relationship
Group - Group An object relationship
GroupPlan - GroupPlan An object relationship
OrderLineItem - OrderLineItem An object relationship
ShippingLine - ShippingLine An object relationship
Subscription - Subscription An object relationship
SubscriptionLine - SubscriptionLine An object relationship
cancelFlowSessionId - uuid
createdAt - timestamptz!
fixedValue - numeric
groupId - uuid
groupPlanId - uuid
id - uuid!
maxTimesUsed - Int
orderLineItemId - uuid
percentage - numeric
platformId - String
redeemCode - String
shippingLineId - uuid
subscriptionId - uuid
subscriptionLineId - uuid
timesUsed - Int
type - String
updatedAt - timestamptz!
Example
{
  "CancelFlowSession": CancelFlowSession,
  "Group": Group,
  "GroupPlan": GroupPlan,
  "OrderLineItem": OrderLineItem,
  "ShippingLine": ShippingLine,
  "Subscription": Subscription,
  "SubscriptionLine": SubscriptionLine,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "fixedValue": numeric,
  "groupId": uuid,
  "groupPlanId": uuid,
  "id": uuid,
  "maxTimesUsed": 987,
  "orderLineItemId": uuid,
  "percentage": numeric,
  "platformId": "abc123",
  "redeemCode": "xyz789",
  "shippingLineId": uuid,
  "subscriptionId": uuid,
  "subscriptionLineId": uuid,
  "timesUsed": 987,
  "type": "xyz789",
  "updatedAt": timestamptz
}
Types

Discount_aggregate_order_by

Description

order by aggregate values of table "Discount"

Fields
Input Field Description
avg - Discount_avg_order_by
count - order_by
max - Discount_max_order_by
min - Discount_min_order_by
stddev - Discount_stddev_order_by
stddev_pop - Discount_stddev_pop_order_by
stddev_samp - Discount_stddev_samp_order_by
sum - Discount_sum_order_by
var_pop - Discount_var_pop_order_by
var_samp - Discount_var_samp_order_by
variance - Discount_variance_order_by
Example
{
  "avg": Discount_avg_order_by,
  "count": "asc",
  "max": Discount_max_order_by,
  "min": Discount_min_order_by,
  "stddev": Discount_stddev_order_by,
  "stddev_pop": Discount_stddev_pop_order_by,
  "stddev_samp": Discount_stddev_samp_order_by,
  "sum": Discount_sum_order_by,
  "var_pop": Discount_var_pop_order_by,
  "var_samp": Discount_var_samp_order_by,
  "variance": Discount_variance_order_by
}
Types

Discount_avg_order_by

Description

order by avg() on columns of table "Discount"

Fields
Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": "asc",
  "maxTimesUsed": "asc",
  "percentage": "asc",
  "timesUsed": "asc"
}
Types

Discount_bool_exp

Description

Boolean expression to filter rows from the table "Discount". All fields are combined with a logical 'AND'.

Fields
Input Field Description
CancelFlowSession - CancelFlowSession_bool_exp
Group - Group_bool_exp
GroupPlan - GroupPlan_bool_exp
OrderLineItem - OrderLineItem_bool_exp
ShippingLine - ShippingLine_bool_exp
Subscription - Subscription_bool_exp
SubscriptionLine - SubscriptionLine_bool_exp