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
A unique identifier for the object.
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 ID of the space this object 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 date and time when the object is planned to be permanently removed. If the value is empty, the object will not 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
The object's current state.
Version
The version is used for optimistic locking and incremented whenever the object is updated.