SubscriptionShippingOption object

A shipping option to deliver a subscription contract.

Required access

Requires shipping and own_subscription_contracts scopes.

On this page

Fields

  • carrierService ([DeliveryCarrierService](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliverycarrierservice))
    The carrier service that is providing this shipping option. This field isn’t currently supported and returns null.
  • code ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The code of the shipping option.
  • description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The description of the shipping option.
  • phoneRequired ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    If a phone number is required for the shipping option.
  • presentmentTitle ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The presentment title of the shipping option.
  • price ([MoneyV2](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    The price of the shipping option.
  • title ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The title of the shipping option.

Types that return SubscriptionShippingOption

  • [SubscriptionShippingOptionResultSuccess.shippingOptions](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionshippingoptionresultsuccess#shippingoptions-2021-01)