Anchor to section titled 'undefined'

SubscriptionDraft
object

Requires read_own_subscription_contracts access scope.

Represents a Subscription Draft.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to SubscriptionDraft.billingCycle
billingCycle
SubscriptionBillingCycle

The billing cycle that the subscription contract will be associated with.

Anchor to SubscriptionDraft.billingPolicy
billingPolicy
SubscriptionBillingPolicy!
non-null

The billing policy for the subscription contract.

Anchor to SubscriptionDraft.concatenatedBillingCycles
concatenatedBillingCycles
Connection
SubscriptionBillingCycleConnection!
non-null

The billing cycles of the contracts that will be concatenated to the subscription contract.

Anchor to SubscriptionDraft.currencyCode
currencyCode
CurrencyCode!
non-null

The currency used for the subscription contract.

Anchor to SubscriptionDraft.customAttributes
customAttributes
[Attribute!]!
non-null

A list of the custom attributes to be added to the generated orders.

Anchor to SubscriptionDraft.customer
customer
Customer!
non-null

The customer to whom the subscription contract belongs.

Anchor to SubscriptionDraft.customerPaymentMethod
customerPaymentMethod
CustomerPaymentMethod

The customer payment method used for the subscription contract.

Anchor to SubscriptionDraft.deliveryMethod
deliveryMethod
SubscriptionDeliveryMethod

The delivery method for each billing of the subscription contract.

Anchor to SubscriptionDraft.deliveryOptions
deliveryOptions
SubscriptionDeliveryOptionResult

The available delivery options for a given delivery address. Returns null for pending requests.

Anchor to SubscriptionDraft.deliveryPolicy
deliveryPolicy
SubscriptionDeliveryPolicy!
non-null

The delivery policy for the subscription contract.

Anchor to SubscriptionDraft.deliveryPrice
deliveryPrice
MoneyV2

The delivery price for each billing the subscription contract.

Anchor to SubscriptionDraft.discounts
discounts
Connection
SubscriptionDiscountConnection!
non-null

The list of subscription discounts which will be associated with the subscription contract.

Anchor to SubscriptionDraft.discountsAdded
discountsAdded
Connection
SubscriptionDiscountConnection!
non-null

The list of subscription discounts to be added to the subscription contract.

Anchor to SubscriptionDraft.discountsRemoved
discountsRemoved
Connection
SubscriptionDiscountConnection!
non-null

The list of subscription discounts to be removed from the subscription contract.

Anchor to SubscriptionDraft.discountsUpdated
discountsUpdated
Connection
SubscriptionDiscountConnection!
non-null

The list of subscription discounts to be updated on the subscription contract.

Anchor to SubscriptionDraft.id
id
ID!
non-null

A globally-unique ID.

Anchor to SubscriptionDraft.lines
lines
Connection
SubscriptionLineConnection!
non-null

The list of subscription lines which will be associated with the subscription contract.

Anchor to SubscriptionDraft.linesAdded
linesAdded
Connection
SubscriptionLineConnection!
non-null

The list of subscription lines to be added to the subscription contract.

Anchor to SubscriptionDraft.linesRemoved
linesRemoved
Connection
SubscriptionLineConnection!
non-null

The list of subscription lines to be removed from the subscription contract.

Anchor to SubscriptionDraft.nextBillingDate
nextBillingDate
DateTime

The next billing date for the subscription contract.

Anchor to SubscriptionDraft.note
note
String

The note field that will be applied to the generated orders.

Anchor to SubscriptionDraft.originalContract
originalContract
SubscriptionContract

The original subscription contract.

Anchor to SubscriptionDraft.status
status
SubscriptionContractSubscriptionStatus

The current status of the subscription contract.

Was this section helpful?
Map
  • No referencing fields
    • SubscriptionDraft
    Anchor to section titled 'Queries'

    Queries

    Anchor to subscriptionDraft
    subscriptionDraft
    query

    Returns a Subscription Draft resource by ID.

    Was this section helpful?
    <?>
    SubscriptionDraft Queries
    SubscriptionDraft

    Queried by

    Anchor to section titled 'Mutations'

    Mutations

    Anchor to subscriptionBillingCycleContractDraftConcatenate
    subscriptionBillingCycleContractDraftConcatenate
    mutation
    Access requirements

    Concatenates a contract to a Subscription Draft.

    Anchor to subscriptionBillingCycleContractEdit
    subscriptionBillingCycleContractEdit
    mutation
    Access requirements

    Edit the contents of a subscription contract for the specified billing cycle.

    Anchor to subscriptionContractCreate
    subscriptionContractCreate
    mutation
    Access requirements

    Creates a Subscription Contract Draft. You can submit all the desired information for the draft using Subscription Draft Input object. You can also update the draft using the Subscription Contract Update mutation. The draft is not saved until you call the Subscription Draft Commit mutation.

    Anchor to subscriptionContractUpdate
    subscriptionContractUpdate
    mutation
    Access requirements

    The subscriptionContractUpdate mutation allows you to create a draft of an existing subscription contract. This draft can be reviewed and modified as needed. Once the draft is committed with subscriptionDraftCommit, the changes are applied to the original subscription contract.

    Anchor to subscriptionDraftDiscountAdd
    subscriptionDraftDiscountAdd
    mutation
    Access requirements

    Adds a subscription discount to a subscription draft.

    Anchor to subscriptionDraftDiscountCodeApply
    subscriptionDraftDiscountCodeApply
    mutation
    Access requirements

    Applies a code discount on the subscription draft.

    Anchor to subscriptionDraftDiscountRemove
    subscriptionDraftDiscountRemove
    mutation
    Access requirements

    Removes a subscription discount from a subscription draft.

    Anchor to subscriptionDraftDiscountUpdate
    subscriptionDraftDiscountUpdate
    mutation
    Access requirements

    Updates a subscription discount on a subscription draft.

    Anchor to subscriptionDraftFreeShippingDiscountAdd
    subscriptionDraftFreeShippingDiscountAdd
    mutation
    Access requirements

    Adds a subscription free shipping discount to a subscription draft.

    Anchor to subscriptionDraftFreeShippingDiscountUpdate
    subscriptionDraftFreeShippingDiscountUpdate
    mutation
    Access requirements

    Updates a subscription free shipping discount on a subscription draft.

    Anchor to subscriptionDraftLineAdd
    subscriptionDraftLineAdd
    mutation
    Access requirements

    Adds a subscription line to a subscription draft.

    Anchor to subscriptionDraftLineRemove
    subscriptionDraftLineRemove
    mutation
    Access requirements

    Removes a subscription line from a subscription draft.

    Anchor to subscriptionDraftLineUpdate
    subscriptionDraftLineUpdate
    mutation
    Access requirements

    Updates a subscription line on a subscription draft.

    Anchor to subscriptionDraftUpdate
    subscriptionDraftUpdate
    mutation
    Access requirements

    Updates a Subscription Draft.

    Was this section helpful?
    <~>
    SubscriptionDraft Mutations
    SubscriptionDraft

    Mutated by

    Anchor to section titled 'Implements'

    Implements

    Anchor to Node
    Node
    interface
    Was this section helpful?
    ||-
    SubscriptionDraft Implements
    SubscriptionDraft

    Implements