Skip to main content
Anchor to SubscriptionBillingCycleChargePayload

SubscriptionBillingCycleChargePayload

payload

Return type for subscriptionBillingCycleCharge mutation.

Anchor to subscriptionBillingAttemptsubscriptionBillingAttempt
•SubscriptionBillingAttempt

The subscription billing attempt.

•[BillingAttemptUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•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.

Arguments

Anchor to subscriptionContractIdsubscriptionContractId
•ID!
required

The ID of the subscription contract.

Anchor to billingCycleSelectorbillingCycleSelector
•SubscriptionBillingCycleSelector!
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.

•SubscriptionBillingAttemptInventoryPolicy
Default:PRODUCT_VARIANT_INVENTORY_POLICY

The behaviour to use when updating inventory.



Was this section helpful?