Skip to main content
Anchor to SubscriptionBillingAttemptInput

SubscriptionBillingAttemptInput

input_object

The input fields required to complete a subscription billing attempt.

Anchor to billingCycleSelectorbillingCycleSelector
•SubscriptionBillingCycleSelector

Select the specific billing cycle to be billed. Default to bill the current billing cycle if not specified.

•String!
non-null

A unique key generated by the client to avoid duplicate payments. For more information, refer to Idempotent requests.

•SubscriptionBillingAttemptInventoryPolicy
Default:PRODUCT_VARIANT_INVENTORY_POLICY

The behaviour to follow when creating an order for a product variant when it's out of stock.

•DateTime

The date and time used to calculate fulfillment intervals for a billing attempt that successfully completed after the current anchor date. To prevent fulfillment from being pushed to the next anchor date, this field can override the billing attempt date.

Anchor to paymentProcessingPolicypaymentProcessingPolicy
•SubscriptionBillingAttemptPaymentProcessingPolicy
Default:FAIL_UNLESS_VALID_PAYMENT_METHOD

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


Was this section helpful?