Documentation
Documentation
Shopify Subscription Product
Close API Documentation
Shopify Subscription Product
States
  • Create
    The subscription product is being created.
  • Active
    The subscription product is active.
  • Inactive
    The subscription product is inactive.
  • Deleting
    The subscription product is in the process of being deleted.
  • Deleted
    The subscription product has been deleted.
  • Obsolete
    The subscription product is obsolete as the linked product has been deleted in Shopify.
Properties
  • Absolute Price Adjustment
  • Billing Day Of Month
    Define the day of the month on which the recurring orders should be created.
  • Billing Interval Amount
  • Billing Interval Unit
    Define how frequently recurring orders should be created.
  • Billing Weekday
    Define the weekday on which the recurring orders should be created.
  • Fixed Price
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Maximal Duration
    Define the maximum number of orders the subscription will run for.
  • Maximal Suspendable Orders
    Define the maximum number of orders the subscription can be suspended for at a time.
  • Minimal Duration
    Define the minimal number of orders the subscription will run for.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Price
  • Pricing Option
  • Product
  • Product Id
    The ID of the Shopify product that is enabled to be ordered as subscription.
  • Product Variant
  • Product Variant Id
  • Relative Price Adjustment
  • SKU
  • Shipping Required
  • Shop
  • State
  • Stock Check Required
  • Store Order Confirmation Email Enabled
    Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.
  • Subscriber Suspension Allowed
    Define whether the customer is allowed to suspend subscriptions.
  • Termination Period
    Define the number of orders the subscription will keep running for after its termination has been requested.
  • Updated At
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.