API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SellingPlan object

Version unstable

Represents a selling plan.

Required access

Requires access to either all or app-owned selling plans.

Fields

billingPolicy (SellingPlanBillingPolicy!)

Selling plan policy which describes the billing details.

createdAt (DateTime!)

The date and time when the selling plan was created.

deliveryPolicy (SellingPlanDeliveryPolicy!)

Selling plan policy which describes the delivery details.

description (String)

Buyer facing string which describes the selling plan commitment.

id (ID!)

Globally unique identifier.

name (String!)

Buyer facing string which describes the selling plan content.

options ([String!]!)

List of options values applied to the selling plan group options.

position (Int)

Relative position of the selling plan for display. A lower position will be displayed before a higher position.

pricingPolicies ([SellingPlanPricingPolicy!]!)

Selling plan pricing details.

Types that return SellingPlan

Implements

Version unstable

Fields

edges ([SellingPlanEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return SellingPlan

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (SellingPlan!)

The item at the end of SellingPlanEdge.

Types that return SellingPlan

Version 2021-01 (Release candidate)

Represents a selling plan.

Required access

Requires access to either all or app-owned selling plans.

Fields

billingPolicy (SellingPlanBillingPolicy!)

Selling plan policy which describes the billing details.

createdAt (DateTime!)

The date and time when the selling plan was created.

deliveryPolicy (SellingPlanDeliveryPolicy!)

Selling plan policy which describes the delivery details.

description (String)

Buyer facing string which describes the selling plan commitment.

id (ID!)

Globally unique identifier.

name (String!)

Buyer facing string which describes the selling plan content.

options ([String!]!)

List of options values applied to the selling plan group options.

position (Int)

Relative position of the selling plan for display. A lower position will be displayed before a higher position.

pricingPolicies ([SellingPlanPricingPolicy!]!)

Selling plan pricing details.

Types that return SellingPlan

Implements

Version 2021-01 (Release candidate)

On this page

Fields

edges ([SellingPlanEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (SellingPlan!)

The item at the end of SellingPlanEdge.

Types that return SellingPlanEdge