Anchor to SubscriptionBillingAttemptInputSubscription
input_objectSubscription Billing Attempt Input
The input fields required to complete a subscription billing attempt.
Anchor to FieldsFields
- billingCycleSelector (SubscriptionBillingCycleSelector)
- idempotencyKey (String!)
- inventoryPolicy (SubscriptionBillingAttemptInventoryPolicy)
- originTime (DateTime)
- paymentProcessingPolicy (SubscriptionBillingAttemptPaymentProcessingPolicy)
- Anchor to billingCycleSelectorbilling•Subscription
Cycle Selector Billing Cycle Selector Select the specific billing cycle to be billed. Default to bill the current billing cycle if not specified.
- Anchor to idempotencyKeyidempotency•String!
Key non-null A unique key generated by the client to avoid duplicate payments. For more information, refer to Idempotent requests.
- Anchor to inventoryPolicyinventory•Subscription
Policy Billing Attempt Inventory Policy Default:PRODUCT_VARIANT_INVENTORY_POLICY The behaviour to follow when creating an order for a product variant when it's out of stock.
- Anchor to originTimeorigin•Date
Time Time 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 paymentProcessingPolicypayment•Subscription
Processing Policy Billing Attempt Payment Processing Policy 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?