Documentation
Documentation
    • English (United States)
Subscription Product
Close
Subscription Product

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.

States
  • Pending
    The product is currently created.
  • Active
    The product is active.
  • Inactive
    The product is inactive.
  • Retiring
    The product is retiring. All associated subscription will be terminated.
  • Retired
    The product is retired and there are no more active subscriptions linked to this product.
Properties
  • Allowed Payment Methods
    The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.
  • Failed Payment Suspension Period
    The period after which a subscription that has been suspended due to a failed payment is terminated.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the product.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Product Locked
    Whether subscriptions can be switched to or from this product, or whether they are locked in.
  • Reference
    The merchant's reference used to identify the product, e.g. the SKU.
  • Sort Order
    When listing products, they can be sorted by this number.
  • Space ID
    The ID of the space this object belongs to.
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.