| Field | Guidance | Relevancy |
|---|---|---|
| Create View | ||
| Product | The Product ID as defined in the Product catalog. Select a product from the dropdown list or use the search bar to search for one. Only products that can use the relevant currency appear in the list.You can add multiple product by clicking the Add Product button.Tip: The first product listed is considered the primary product for the subscription. It is the product associated with the subscription in the Subscribe Dashboards and Reports. | Required |
| ID | Enter your unique ID that associates the product being purchased to the Subscription. | Required |
| Quantity | Enter the number of units of a product purchased in this subscription. Subscribe uses this number to determine the cost of the item to the customer. For license-based items (rated, pre-paid products), the Quantity value will be used with the appropriate Rate Plan tier structure to determine the charge. Usage based pricing will be calculated based on how many items were reported during the billing period so don’t use the quantity field. | Required |
| Campaign Code | Enter a campaign code (Promotion or coupon code) to be applied to this product, if applicable. | Optional |
| Override Pricing Defaults | Yes/No toggle. If you wish to override the default pricing for this product on this subscription select Yes and enter the relevant currency and amount or select default to use the Product price. Default value is No. | Optional |
| Start Date | Click the calendar icon to select a date you want the Subscription Item (Product) to become Active on the subscription. By default, the current date appears. | Required |
| Cycle Unlimited | Yes/No toggle. If you want to specify the number of cycles relevant for the subscription, move to No and enter the number of Times you want the billing cycle to repeat. Default value is Yes. | Optional |
| Cycles Left | The number of remaining billing cycles relevant for the product within the subscription. This is calculated and is updated after each billing cycle. | Read Only |
| Add Product | To add additional products to the subscription click the Add Product button and fill out the appropriate fields | Optional |
| Editing an active subscription | ||
| Modify Active Item | Reopens the active subscription item and allows you to remove the item or change its settings. Click the Remove Item button to remove entirely from the subscription.Note: When modifying a Subscription Item, the ID field is optional. For all new Subscription Items, the ID field is required. | Optional |
| Update Option | When modifying a subscription you must select an update option this will govern all modifications to the Subscription. - Update Now, No Proration(default value)—Add/remove the product now, entitle/disentitle now but don’t change any billing. - Update Now, Prorate—Add/remove the product now, entitle/disentitle now calculate credits for removed items and charges for added items and bill or credit account accordingly. - Update Next Billing Period—Add/Remove the product and entitle/disentitle at the next billing cycle. No proration necessary. | Required |
| When viewing the Subscription Items Pane | ||
| Product | The unique identifier of the associated product. Click the Product ID to access the relevant product page | Optional |
| Item | The Unique identifier that associates this product to the subscription. | Read only |
| Start Date and End Date | Specifies when the subscription was activated and when it ends. If the end date is not known this field remains blank. It will be populated when and if the product is removed from the subscription. | Read only |
| Qty | Quantity of the product item units purchased by the subscription. For license-based rated products, Quantity indicates the license count and is used to calculate the amount based on the rating tables. | Read only |
| Price | The total price of the item (including tax) and currency as represented by the national flag. | Read only |
| Description | The billing plan description. | Read only |
| Campaign ID | If a campaign code was applied to the Subscription Item during purchasing, the campaign ID of the associated campaign appears for the item. | Read only |
| Cycles | This displays the current cycle of the subscription. For example if the third billing cycle of the billing plan is complete this will be 3. Each cycle that completes will increment this count until this billing cycle is complete. | Read only |
| Cycles Left | The number of remaining billing cycles relevant for the product within the subscription. | Read only |
| Parent topic:Working with Subscriptions |
Subscription Items Pane
Subscription Items are the Products and services included in the subscription. In order to enable the field, ensure that you selected the relevant currency in the Currency field that is part of the details pane.When editing Subscription Items that are active, note that additional fields are added.
Parent topic:Viewing Subscription Info