Documentation
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 subscription linked with this product.
Properties
  • Allowed Payment Method Configurations
    The allowed payment method configurations control which payment methods can be used with this product. When none is selected all methods will be allowed.
  • Failed Payment Suspension Period
    When a payment fails, the subscription to which the payment belongs to will be suspended. When the suspension is not removed within the specified period the subscription will be terminated. A payment is considered as failed when the subscriber issues a refund or when a subscription charge fails.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Is Product Locked
    Marks the product as locked. Meaning that customer can not change away from this product or change to this product later on.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Name
    The product name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • 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.
  • Reference
    The product reference identifies the product for external systems. This field may contain the product's SKU.
  • Sort Order
    The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.
  • Space Id
  • State
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.