Skip to main content
Anchor to SubscriptionBillingCycleBulkChargePayload

SubscriptionBillingCycleBulkChargePayload

payload

Return type for subscriptionBillingCycleBulkCharge mutation.

•Job

The asynchronous job that performs the action on the targeted billing cycles.

Show fields
•[SubscriptionBillingCycleBulkUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Asynchronously queries and charges all subscription billing cycles whose billingAttemptExpectedDate values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the subscriptionBillingCycleBulkResults query.

Show payload

Arguments

Anchor to billingAttemptExpectedDateRangebillingAttemptExpectedDateRange
•SubscriptionBillingCyclesDateRangeSelector!
required

Specifies the date range within which the billingAttemptExpectedDate values of the billing cycles should fall.

Show input fields
•SubscriptionBillingCycleBulkFilters

Criteria to filter the billing cycles on which the action is executed.

Show input fields
•SubscriptionBillingAttemptInventoryPolicy
Default:PRODUCT_VARIANT_INVENTORY_POLICY

The behaviour to use when updating inventory.

Show enum values
Anchor to paymentProcessingPolicypaymentProcessingPolicy
•SubscriptionBillingAttemptPaymentProcessingPolicy
Default:FAIL_UNLESS_VALID_PAYMENT_METHOD

Selected payment processing policy for the billing attempt. Defaults to FAIL_UNLESS_VALID_PAYMENT_METHOD.

Show enum values


Was this section helpful?