SubscriptionOrder

One billing cycle of a subscription. Processing it charges the customer and creates an order.

type SubscriptionOrder {
  assignedShippingOption: SubscriptionDeliveryShippingOption
  billingBehaviour: SubscriptionBillingBehaviour!
  buildStatus: SubscriptionOrderBuildStatus!
  cancelledAt: Timestamp
  createdAt: Timestamp!
  customAttributes: [CustomAttribute!]!
  customer: Customer!
  customised: Boolean!
  cycleEndAt: Timestamp!
  cycleIndex: Count!
  cycleStartAt: Timestamp!
  deliveryBehaviour: SubscriptionDeliveryBehaviour!
  deliveryMethod: SubscriptionDeliveryMethod
  events(
    after: String
    before: String
    first: Int
    last: Int
  ): SubscriptionEventConnection!
  expectedBillingAt: Timestamp
  expectedDeliveryAt: Timestamp
  externalCycleIndex: Count
  failedBuildCount: Count!
  failedPaymentCaptureCount: Count!
  financials: SubscriptionOrderFinancials
  financialsSet: SubscriptionOrderFinancialsSet!
  flagged: Boolean!
  flaggedAt: Timestamp
  flaggedDescription: String
  flaggedReason: SubscriptionOrderFlaggedReason
  id: GlobalID!
  identifier: String!
  lastBuildErrors: [String!]!
  lastPaymentMethodUpdateEvent: SubscriptionEvent
  leadingScheduledOrdersCount: Count!
  lines: [SubscriptionOrderLine!]
  multiCurrency: Boolean!
  nextSubscriptionOrder: SubscriptionOrder
  notes: String
  order: Order
  paused: Boolean!
  paymentIntent: PaymentIntent
  paymentMethod: PaymentMethod
  paymentStatus: SubscriptionOrderPaymentStatus!
  presentmentCurrency: CurrencyCode!
  previousSubscriptionOrder: SubscriptionOrder
  priceStatus: SubscriptionOrderPriceStatus!
  processedAt: Timestamp
  retryPaymentAt: Timestamp
  shopCurrency: CurrencyCode!
  skipped: Boolean!
  skippedAt: Timestamp
  skippedByPlatform: Boolean!
  skippedReason: String
  status: SubscriptionOrderStatus!
  subscription: Subscription!
  subscriptionDiscounts: [SubscriptionDiscount!]!
  trailingProcessedOrdersCount: Count!
  unflaggedAt: Timestamp
  updatedAt: Timestamp!
}

Fields

SubscriptionOrder.assignedShippingOption ● SubscriptionDeliveryShippingOption object types

The shipping option assigned to the subscription order when its prices were calculated.

SubscriptionOrder.billingBehaviour ● SubscriptionBillingBehaviour! non-null object types

The subscription order's billing behaviour, copied from its subscription.

SubscriptionOrder.buildStatus ● SubscriptionOrderBuildStatus! non-null enum types

The status of building the subscription order in its channel before processing.

SubscriptionOrder.cancelledAt ● Timestamp scalar types

The date and time when the subscription order was cancelled.

SubscriptionOrder.createdAt ● Timestamp! non-null scalar types

The date and time when the subscription order was created.

SubscriptionOrder.customAttributes ● [CustomAttribute!]! non-null object types

The subscription order's custom attributes.

SubscriptionOrder.customer ● Customer! non-null object types

The customer the subscription order belongs to.

SubscriptionOrder.customised ● Boolean! non-null scalar types

Whether the subscription order has been customised.

SubscriptionOrder.cycleEndAt ● Timestamp! non-null scalar types

The date and time when the subscription order's billing cycle ends.

SubscriptionOrder.cycleIndex ● Count! non-null scalar types

The subscription order's position in its subscription's billing cycles. Cycle 0 is the order that started the subscription.

SubscriptionOrder.cycleStartAt ● Timestamp! non-null scalar types

The date and time when the subscription order's billing cycle starts.

SubscriptionOrder.deliveryBehaviour ● SubscriptionDeliveryBehaviour! non-null object types

The subscription order's delivery behaviour, copied from its subscription.

SubscriptionOrder.deliveryMethod ● SubscriptionDeliveryMethod union types

How the subscription order is delivered. Only shipping delivery methods are returned.

SubscriptionOrder.events ● SubscriptionEventConnection! non-null object types

The events recorded for the subscription order.

SubscriptionOrder.events.after ● String scalar types

Returns the elements in the list that come after the specified cursor.

SubscriptionOrder.events.before ● String scalar types

Returns the elements in the list that come before the specified cursor.

SubscriptionOrder.events.first ● Int scalar types

Returns the first _n_ elements from the list.

SubscriptionOrder.events.last ● Int scalar types

Returns the last _n_ elements from the list.

SubscriptionOrder.expectedBillingAt ● Timestamp scalar types

The date and time when the subscription order is expected to be billed.

SubscriptionOrder.expectedDeliveryAt ● Timestamp scalar types

The date and time when the subscription order is expected to be delivered.

SubscriptionOrder.externalCycleIndex ● Count scalar types

The billing cycle index the channel uses for the subscription order, such as Shopify's cycle index.

SubscriptionOrder.failedBuildCount ● Count! non-null scalar types

The number of times building the subscription order has failed.

SubscriptionOrder.failedPaymentCaptureCount ● Count! non-null scalar types

The number of failed payment attempts for the subscription order.

SubscriptionOrder.financials ● SubscriptionOrderFinancials object types

The subscription order's financial details in the shop's currency.

SubscriptionOrder.financialsSet ● SubscriptionOrderFinancialsSet! non-null object types

The subscription order's financial details in shop and presentment currencies.

SubscriptionOrder.flagged ● Boolean! non-null scalar types

Whether the subscription order is flagged because of a problem. Flagged orders aren't processed until they're unflagged.

SubscriptionOrder.flaggedAt ● Timestamp scalar types

The date and time when the subscription order was last flagged.

SubscriptionOrder.flaggedDescription ● String scalar types

A description of why the subscription order is flagged. Empty when it isn't flagged.

SubscriptionOrder.flaggedReason ● SubscriptionOrderFlaggedReason enum types

The reason the subscription order was flagged.

SubscriptionOrder.id ● GlobalID! non-null scalar types

The subscription order's ID.

SubscriptionOrder.identifier ● String! non-null scalar types

The subscription order's identifier, made from its subscription's identifier and cycle index, such as #1001-003.

SubscriptionOrder.lastBuildErrors ● [String!]! non-null scalar types

The errors from the subscription order's most recent failed build.

SubscriptionOrder.lastPaymentMethodUpdateEvent ● SubscriptionEvent object types

The most recent event that changed the subscription order's payment method.

SubscriptionOrder.leadingScheduledOrdersCount ● Count! non-null scalar types

The number of earlier subscription orders for the same subscription that are still scheduled.

SubscriptionOrder.lines ● [SubscriptionOrderLine!] list object types

The subscription order's lines.

SubscriptionOrder.multiCurrency ● Boolean! non-null scalar types

Whether the subscription order's presentment currency differs from the shop's currency.

SubscriptionOrder.nextSubscriptionOrder ● SubscriptionOrder object types

The subscription order for the next billing cycle.

SubscriptionOrder.notes ● String scalar types

Notes about the subscription order.

SubscriptionOrder.order ● Order object types

The order created when the subscription order was processed.

SubscriptionOrder.paused ● Boolean! non-null scalar types

Whether the subscription order is paused because its subscription is paused.

SubscriptionOrder.paymentIntent ● PaymentIntent object types

The payment intent for the subscription order.

SubscriptionOrder.paymentMethod ● PaymentMethod object types

The payment method that pays for the subscription order.

SubscriptionOrder.paymentStatus ● SubscriptionOrderPaymentStatus! non-null enum types

The status of the subscription order's payment.

SubscriptionOrder.presentmentCurrency ● CurrencyCode! non-null enum types

The currency presented to the customer.

SubscriptionOrder.previousSubscriptionOrder ● SubscriptionOrder object types

The subscription order for the previous billing cycle. Empty for cycles 0 and 1.

SubscriptionOrder.priceStatus ● SubscriptionOrderPriceStatus! non-null enum types

The status of the subscription order's price calculation.

SubscriptionOrder.processedAt ● Timestamp scalar types

The date and time when the subscription order was processed.

SubscriptionOrder.retryPaymentAt ● Timestamp scalar types

The date and time of the next payment attempt after a failed payment.

SubscriptionOrder.shopCurrency ● CurrencyCode! non-null enum types

The shop's currency.

SubscriptionOrder.skipped ● Boolean! non-null scalar types

Whether the subscription order is skipped.

SubscriptionOrder.skippedAt ● Timestamp scalar types

The date and time when the subscription order was skipped.

SubscriptionOrder.skippedByPlatform ● Boolean! non-null scalar types

Whether Submarine skipped the subscription order automatically.

SubscriptionOrder.skippedReason ● String scalar types

The reason given for skipping the subscription order.

SubscriptionOrder.status ● SubscriptionOrderStatus! non-null enum types

The subscription order's status.

SubscriptionOrder.subscription ● Subscription! non-null object types

The subscription the subscription order belongs to.

SubscriptionOrder.subscriptionDiscounts ● [SubscriptionDiscount!]! non-null object types

The subscription order's subscription discounts.

SubscriptionOrder.trailingProcessedOrdersCount ● Count! non-null scalar types

The number of later subscription orders for the same subscription that have already been processed.

SubscriptionOrder.unflaggedAt ● Timestamp scalar types

The date and time when the subscription order was last unflagged.

SubscriptionOrder.updatedAt ● Timestamp! non-null scalar types

The date and time when the subscription order was last updated.

Returned By

subscriptionOrder query

Member Of

Subscription object ● SubscriptionEvent object ● SubscriptionOrder object ● SubscriptionOrderConnection object ● SubscriptionOrderEdge object ● SubscriptionOrderLine object ● SubscriptionOrderLineAddPayload object ● SubscriptionOrderLineRemovePayload object ● SubscriptionOrderLineSetQuantityPayload object ● SubscriptionOrderProcessPayload object ● SubscriptionOrderReschedulePayload object ● SubscriptionOrderSetDeliveryDatePayload object ● SubscriptionOrderSkipPayload object ● SubscriptionOrderUnflagPayload object ● SubscriptionOrderUnskipPayload object ● SubscriptionOrderUpdatePayload object