Billing
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 billing attempt to charge for a
. The mutation processes either the payment for the current billing cycle or for a specific cycle, if selected.The mutation creates an
Orderwhen successful. Failed billing attempts include afield with error details.TipYou can target a specific billing cycle using the
to bill past or future cycles. Theparameter adjusts fulfillment scheduling for attempts completed after the expected billing date.Learn more about creating billing attempts.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
- Anchor to subscriptionBillingAttemptInputsubscription•Subscription
Billing Attempt Input Billing Attempt Input! required The information to apply as a billing attempt.
Arguments
- •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 subscriptionContractIdsubscription•ID!
Contract Id required The ID of the 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 Policy Default:PRODUCT_VARIANT_INVENTORY_POLICY The behaviour to use when updating inventory.
Arguments