Billing Attempt User Error
Requires access scope.
Represents an error that happens during the execution of a billing attempt mutation.
Anchor to FieldsFields
- Anchor to codecode•Billing
Attempt User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Creates a new subscription billing attempt. For more information, refer to Create a subscription contract.
- Anchor to subscriptionBillingAttemptInputsubscription•Subscription
Billing Attempt Input Billing Attempt Input!required The information to apply as a billing attempt.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract.
Arguments
- Anchor to subscriptionBillingAttemptsubscription•Subscription
Billing Attempt Billing Attempt The subscription billing attempt.
- Anchor to userErrorsuser•[Billing
Errors Attempt User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for subscriptionBillingAttemptCreate. For more information, refer to Create a subscription contract.
- Anchor to billingCycleSelectorbilling•Subscription
Cycle Selector Billing Cycle Selector!required Select the specific billing cycle to be billed. If the selected billing cycle's billingAttemptExpectedDate is in the past, the originTime of the billing attempt will be set to this date. However, if the billingAttemptExpectedDate is in the future, the originTime will be the current time.
- Anchor to inventoryPolicyinventory•Subscription
Policy Billing Attempt Inventory PolicyDefault:PRODUCT_VARIANT_INVENTORY_POLICY The behaviour to use when updating inventory.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract.
Arguments
- Anchor to subscriptionBillingAttemptsubscription•Subscription
Billing Attempt Billing Attempt The subscription billing attempt.
- Anchor to userErrorsuser•[Billing
Errors Attempt User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields