Skip to main content

SubscriptionsConfig

The subscription settings for a channel.

type SubscriptionsConfig {
  autoCorrectSubscriptionOrderBacklog: Boolean!
  calculatePricesBeforeProcessing: Boolean!
  defaultPaymentRetryPolicy: SubscriptionRetryPolicy!
  defaultSubscriptionBacklogSize: SubscriptionBacklogSize!
  flaggedOrderProcessingThresholdMins: Count!
  permittedFrequencyIntervals: [SubscriptionInterval!]!
  permittedRetryIntervals: [SubscriptionRetryInterval!]!
  processSubscriptionOrders: Boolean!
  processingWindowMins: Count!
  requireShippingAddressPhoneNumber: Boolean!
  subscriptionEngine: SubscriptionEngine!
  throttledRequestRetryPolicy: BackoffPolicy!
}

Fields​

SubscriptionsConfig.autoCorrectSubscriptionOrderBacklog ● Boolean! non-null scalar types​

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

SubscriptionsConfig.calculatePricesBeforeProcessing ● Boolean! non-null scalar types​

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

SubscriptionsConfig.defaultPaymentRetryPolicy ● SubscriptionRetryPolicy! non-null object types​

The policy for retrying failed subscription order payments.

SubscriptionsConfig.defaultSubscriptionBacklogSize ● SubscriptionBacklogSize! non-null object types​

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

SubscriptionsConfig.flaggedOrderProcessingThresholdMins ● Count! non-null scalar types​

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

SubscriptionsConfig.permittedFrequencyIntervals ● [SubscriptionInterval!]! non-null enum types​

The intervals that subscription frequencies on the channel can use.

SubscriptionsConfig.permittedRetryIntervals ● [SubscriptionRetryInterval!]! non-null enum types​

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

SubscriptionsConfig.processSubscriptionOrders ● Boolean! non-null scalar types​

Whether Submarine processes due subscription orders for the channel.

SubscriptionsConfig.processingWindowMins ● Count! non-null scalar types​

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

SubscriptionsConfig.requireShippingAddressPhoneNumber ● Boolean! non-null scalar types​

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

SubscriptionsConfig.subscriptionEngine ● SubscriptionEngine! non-null enum types​

The engine that manages the channel's subscriptions.

SubscriptionsConfig.throttledRequestRetryPolicy ● BackoffPolicy! non-null object types​

The backoff policy for retrying throttled requests.

Member Of​

PlatformConfig object