Starfish API Documentation

Subscription

Subscription

  • checkoutOrder: CheckoutOrder!

    The checkout order that was checked out to create this subscription

  • firstSupplyDate: ISO8601Date

    The date this subscription is to fulfill or has fulfilled its first order

  • id: ID!

  • lineItems: [LineItem!]!

    Line items subscribed to on this subscription

  • orders: SubscriptionOrderConnection!

    The historical orders fulfilled by this subscription

    Argumentschevron-right
  • paymentMethod: PaymentMethodInterface!

    The payment method that will be used on the next payment towards this subscription

  • payments: PaymentConnection!

    The payments paid towards this subscription

    Argumentschevron-right
  • prescriptions: [PrescriptionInterface!]!

    The prescriptions associated with the line items in this subscription

  • scheduledOrders: [SubscriptionOrder!]!

    The upcoming orders to be fulfilled by this subscription

  • scheduledPayments: [ScheduledPayment!]!

    Upcoming payments to be made towards this subscription

  • shippingAddress: ShippingAddress!

    The shipping address that will be used for the next shipment on this subscription

  • status: String

    Status of the subscription

  • url: Url!

    URL for accessing the subscription

  • user: AccountHolder!

    The user who owns this subscription

SubscriptionConnection

The connection type for Subscription.

SubscriptionEdge

An edge in a connection.

  • cursor: String!

    A cursor for use in pagination.

  • node: Subscription

    The item at the end of the edge.