Choose a version:

subscriptionDraft

query

Returns a Subscription Draft resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the Subscription Draft to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

SubscriptionDraft

•

SubscriptionDraft

Represents a Subscription Draft.

billingCycle• SubscriptionBillingCycle: The billing cycle that the subscription contract will be associated with.
billingPolicy• SubscriptionBillingPolicy! non-null: The billing policy for the subscription contract.
concatenatedBillingCycles • SubscriptionBillingCycleConnection! non-null: The billing cycles of the contracts that will be concatenated to the subscription contract.
currencyCode• CurrencyCode! non-null: The currency used for the subscription contract.
customAttributes• [Attribute!]! non-null: A list of the custom attributes to be added to the generated orders.
customer• Customer! non-null: The customer to whom the subscription contract belongs.
customerPaymentMethod• CustomerPaymentMethod: The customer payment method used for the subscription contract.
deliveryMethod• SubscriptionDeliveryMethod: The delivery method for each billing of the subscription contract.
deliveryOptions• SubscriptionDeliveryOptionResult: The available delivery options for a given delivery address. Returns null for pending requests.
deliveryPolicy• SubscriptionDeliveryPolicy! non-null: The delivery policy for the subscription contract.
deliveryPrice• MoneyV2: The delivery price for each billing the subscription contract.
discounts • SubscriptionDiscountConnection! non-null: The list of subscription discounts which will be associated with the subscription contract.
discountsAdded • SubscriptionDiscountConnection! non-null: The list of subscription discounts to be added to the subscription contract.
discountsRemoved • SubscriptionDiscountConnection! non-null: The list of subscription discounts to be removed from the subscription contract.
discountsUpdated • SubscriptionDiscountConnection! non-null: The list of subscription discounts to be updated on the subscription contract.
id• ID! non-null: A globally-unique ID.
lines • SubscriptionLineConnection! non-null: The list of subscription lines which will be associated with the subscription contract.
linesAdded • SubscriptionLineConnection! non-null: The list of subscription lines to be added to the subscription contract.
linesRemoved • SubscriptionLineConnection! non-null: The list of subscription lines to be removed from the subscription contract.
nextBillingDate• DateTime: The next billing date for the subscription contract.
note• String: The note field that will be applied to the generated orders.
originalContract• SubscriptionContract: The original subscription contract.
status• SubscriptionContractSubscriptionStatus: The current status of the subscription contract.
shippingOptions• SubscriptionShippingOptionResult: Available Shipping Options for a given delivery address. Returns NULL for pending requests.

Was this section helpful?