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
)The carrier service that is providing this shipping option. This field isn't currently supported and returns null.
-
code (
String!
)The code of the shipping option.
-
description (
String
)The description of the shipping option.
-
phoneRequired (
Boolean
)If a phone number is required for the shipping option.
-
presentmentTitle (
String
)The presentment title of the shipping option.
-
price (
MoneyV2
)The price of the shipping option.
-
title (
String!
)The title of the shipping option.
Types that return SubscriptionShippingOption
A shipping option to deliver a subscription contract.
Required access
Requires shipping and own_subscription_contracts scopes.
On this page
Fields
-
carrierService (
DeliveryCarrierService
)The carrier service that is providing this shipping option. This field isn't currently supported and returns null.
-
code (
String!
)The code of the shipping option.
-
description (
String
)The description of the shipping option.
-
phoneRequired (
Boolean
)If a phone number is required for the shipping option.
-
presentmentTitle (
String
)The presentment title of the shipping option.
-
price (
MoneyV2
)The price of the shipping option.
-
title (
String!
)The title of the shipping option.
Types that return SubscriptionShippingOption
A shipping option to deliver a subscription contract.
Required access
Requires shipping and own_subscription_contracts scopes.
On this page
Fields
-
carrierService (
DeliveryCarrierService
)The carrier service that is providing this shipping option. This field isn't currently supported and returns null.
-
code (
String!
)The code of the shipping option.
-
description (
String
)The description of the shipping option.
-
phoneRequired (
Boolean
)If a phone number is required for the shipping option.
-
presentmentTitle (
String
)The presentment title of the shipping option.
-
price (
MoneyV2
)The price of the shipping option.
-
title (
String!
)The title of the shipping option.