subscriptionDraftUpdate mutation
Updates a Subscription Draft.
Required access
write_own_subscription_contracts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The gid of the Subscription Draft to update. |
input
(
SubscriptionDraftInput!
)
required
|
The properties of the new Subscription Contract. |
SubscriptionDraftInput fields
-
billingPolicy (
SubscriptionBillingPolicyInput
)The billing policy for the subscription contract.
-
deliveryMethod (
SubscriptionDeliveryMethodInput
)The delivery method for the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicyInput
)The delivery policy for the subscription contract.
-
deliveryPrice (
Decimal
)The shipping price for each renewal the subscription contract.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
paymentMethodId (
ID
)The ID of the payment method to be used for the subscription contract.
-
The current status of the subscription contract.
Return fields
-
draft (
SubscriptionDraft
)The Subscription Draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.
Updates a Subscription Draft.
Required access
write_own_subscription_contracts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The gid of the Subscription Draft to update. |
input
(
SubscriptionDraftInput!
)
required
|
The properties of the new Subscription Contract. |
SubscriptionDraftInput fields
-
billingPolicy (
SubscriptionBillingPolicyInput
)The billing policy for the subscription contract.
-
deliveryMethod (
SubscriptionDeliveryMethodInput
)The delivery method for the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicyInput
)The delivery policy for the subscription contract.
-
deliveryPrice (
Decimal
)The shipping price for each renewal the subscription contract.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
paymentMethodId (
ID
)The ID of the payment method to be used for the subscription contract.
-
The current status of the subscription contract.
Return fields
-
draft (
SubscriptionDraft
)The Subscription Draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.
Updates a Subscription Draft.
Required access
write_own_subscription_contracts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The gid of the Subscription Draft to update. |
input
(
SubscriptionDraftInput!
)
required
|
The properties of the new Subscription Contract. |
SubscriptionDraftInput fields
-
billingPolicy (
SubscriptionBillingPolicyInput
)The billing policy for the subscription contract.
-
deliveryMethod (
SubscriptionDeliveryMethodInput
)The delivery method for the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicyInput
)The delivery policy for the subscription contract.
-
deliveryPrice (
Decimal
)The shipping price for each renewal the subscription contract.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
paymentMethodId (
ID
)The ID of the payment method to be used for the subscription contract.
-
The current status of the subscription contract.
Return fields
-
draft (
SubscriptionDraft
)The Subscription Draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.