Skip to main content

SubscriptionsConfigSetInput

The input fields for setting a channel's subscription settings.

input SubscriptionsConfigSetInput {
  autoCorrectSubscriptionOrderBacklog: Boolean
  calculatePricesBeforeProcessing: Boolean
  defaultPaymentRetryPolicy: SubscriptionRetryPolicyInput
  defaultSubscriptionBacklogSize: SubscriptionBacklogSizeInput
  flaggedOrderProcessingThresholdMins: Count
  permittedFrequencyIntervals: [SubscriptionInterval!]
  permittedRetryIntervals: [SubscriptionRetryInterval!]
  processSubscriptionOrders: Boolean
  processingWindowMins: Count
  requireShippingAddressPhoneNumber: Boolean
  subscriptionEngine: SubscriptionEngine
  throttledRequestRetryPolicy: BackoffPolicyInput
}

Fields​

SubscriptionsConfigSetInput.autoCorrectSubscriptionOrderBacklog ● Boolean scalar types​

Whether Submarine checks and fixes a subscription's order backlog before processing its due orders.

SubscriptionsConfigSetInput.calculatePricesBeforeProcessing ● Boolean scalar types​

Whether to recalculate a subscription order's prices when processing starts.

SubscriptionsConfigSetInput.defaultPaymentRetryPolicy ● SubscriptionRetryPolicyInput input types​

The policy for retrying failed subscription order payments.

SubscriptionsConfigSetInput.defaultSubscriptionBacklogSize ● SubscriptionBacklogSizeInput input types​

How many subscription orders to keep scheduled ahead for each subscription.

SubscriptionsConfigSetInput.flaggedOrderProcessingThresholdMins ● Count scalar types​

A threshold, in minutes, for processing flagged subscription orders.

SubscriptionsConfigSetInput.permittedFrequencyIntervals ● [SubscriptionInterval!] list enum types​

The intervals that subscription frequencies on the channel can use.

SubscriptionsConfigSetInput.permittedRetryIntervals ● [SubscriptionRetryInterval!] list enum types​

The intervals that payment retry policies on the channel can use.

SubscriptionsConfigSetInput.processSubscriptionOrders ● Boolean scalar types​

Whether Submarine processes due subscription orders for the channel.

SubscriptionsConfigSetInput.processingWindowMins ● Count scalar types​

The length of the processing window for subscription orders, in minutes.

SubscriptionsConfigSetInput.requireShippingAddressPhoneNumber ● Boolean scalar types​

Whether shipping addresses on subscriptions and subscription orders must include a phone number.

SubscriptionsConfigSetInput.subscriptionEngine ● SubscriptionEngine enum types​

The engine that manages the channel's subscriptions.

SubscriptionsConfigSetInput.throttledRequestRetryPolicy ● BackoffPolicyInput input types​

The backoff policy for retrying throttled requests.

Member Of​

PlatformConfigSetInput input