Anchor to section titled 'undefined'

SubscriptionDraftErrorCode
enum

Possible error codes that can be returned by SubscriptionDraftUserError.


value-alreadyremoved
ALREADY_REMOVED

This line has already been removed.

value-billingcycleabsent
BILLING_CYCLE_ABSENT

Cannot commit a contract draft with this mutation. Please use SubscriptionDraftCommit.

value-billingcyclecontractdraftbillingpolicyinvalid
BILLING_CYCLE_CONTRACT_DRAFT_BILLING_POLICY_INVALID

Billing policy cannot be updated for billing cycle contract drafts.

value-billingcyclecontractdraftdeliverypolicyinvalid
BILLING_CYCLE_CONTRACT_DRAFT_DELIVERY_POLICY_INVALID

Delivery policy cannot be updated for billing cycle contract drafts.

value-billingcyclepresent
BILLING_CYCLE_PRESENT

Cannot commit a billing cycle contract draft with this mutation. Please use SubscriptionBillingCycleContractDraftCommit.

The input value is blank.

Subscription draft has been already committed.

value-concatenationbillingcyclecontractdraftrequired
CONCATENATION_BILLING_CYCLE_CONTRACT_DRAFT_REQUIRED

Contract draft must be a billing cycle contract draft for contract concatenation.

value-currencynotenabled
CURRENCY_NOT_ENABLED

Currency is not enabled.

value-customerdoesnotexist
CUSTOMER_DOES_NOT_EXIST

The customer doesn't exist.

value-customermismatch
CUSTOMER_MISMATCH

The payment method customer must be the same as the contract customer.

value-customerredacted
CUSTOMER_REDACTED

Customer is scheduled for redaction or has been redacted.

value-cyclediscountsuniqueaftercycle
CYCLE_DISCOUNTS_UNIQUE_AFTER_CYCLE

The after cycle attribute must be unique between cycle discounts.

value-cycleindexoutofrange
CYCLE_INDEX_OUT_OF_RANGE

Billing cycle selector cannot select billing cycle outside of index range.

value-cycleselectorvalidateoneof
CYCLE_SELECTOR_VALIDATE_ONE_OF

Billing cycle selector requires exactly one of index or date to be provided.

value-cyclestartdateoutofrange
CYCLE_START_DATE_OUT_OF_RANGE

Billing cycle selector cannot select billing cycle outside of start date range.

value-deliverymethodrequired
DELIVERY_METHOD_REQUIRED

The delivery method can't be blank if any lines require shipping.

value-deliverymustbemultipleofbilling
DELIVERY_MUST_BE_MULTIPLE_OF_BILLING

The delivery policy interval must be a multiple of the billing policy interval.

value-duplicateconcatenatedcontracts
DUPLICATE_CONCATENATED_CONTRACTS

Concatenated contracts cannot contain duplicate subscription contracts.

value-exceededmaxconcatenatedcontracts
EXCEEDED_MAX_CONCATENATED_CONTRACTS

Maximum number of concatenated contracts on a billing cycle contract draft exceeded.

value-greaterthan
GREATER_THAN

The input value should be greater than the minimum allowed value.

value-greaterthanorequalto
GREATER_THAN_OR_EQUAL_TO

The input value should be greater than or equal to the minimum value allowed.

value-hasfutureedits
HAS_FUTURE_EDITS

Cannot update a subscription contract with a current or upcoming billing cycle contract edit.

The input value is invalid.

value-invalidadjustmenttype
INVALID_ADJUSTMENT_TYPE

The adjustment value must the same type as the adjustment type.

value-invalidadjustmentvalue
INVALID_ADJUSTMENT_VALUE

The adjustment value must be either fixed_value or percentage.

value-invalidbillingdate
INVALID_BILLING_DATE

Next billing date is invalid.

value-invalidlines
INVALID_LINES

Must have at least one line.

value-invalidnotelength
INVALID_NOTE_LENGTH

Note length is too long.

The input value should be less than the maximum value allowed.

value-lessthanorequalto
LESS_THAN_OR_EQUAL_TO

The input value should be less than or equal to the maximum value allowed.

value-missinglocaldeliveryoptions
MISSING_LOCAL_DELIVERY_OPTIONS

The local delivery options must be set for local delivery.

value-notaninteger
NOT_AN_INTEGER

The value is not an integer.

value-notinrange
NOT_IN_RANGE

Value is not in range.

value-noentitledlines
NO_ENTITLED_LINES

Discount must have at least one entitled line.

Input value is not present.

value-sellingplanmaxcyclesmustbegreaterthanmincycles
SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES

The maximum number of cycles must be greater than the minimum.

value-stalecontract
STALE_CONTRACT

Another operation updated the contract concurrently as the commit was in progress.

The input value is too long.

The input value is too short.

value-upcomingcyclelimitexceeded
UPCOMING_CYCLE_LIMIT_EXCEEDED

Billing cycle selector cannot select upcoming billing cycle past limit.


Was this section helpful?

The error code.


Was this section helpful?
Map
SubscriptionDraftErrorCode