| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | String | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | DateTime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| id | String | {"description":"ID uniquely identifying this product.","verbs":["GET"]} | [optional] |
| crm_id | String | {"description":"Customer-relationship-management ID of the product.","verbs":["GET","PUT","POST"]} | [optional] |
| account_id | String | {"description":"","verbs":[]} | [optional] |
| name | String | {"description":"A unique name — for your benefit — used to identify this product within BillForward. It should reflect the fact that this product confers some service to a customer (e.g. \"Gold membership\").<br>The product can also be defined by the frequency with which it recurs (e.g. \"Monthly Gold membership\").<br>Remember also that rate plans can override the timing prescribed by their product. If you intend to override that timing, you may consider the product's period duration to be an unimportant factor when it comes to naming it.","verbs":["POST","PUT","GET"]} | |
| public_name | String | {"description":"A friendly non-unique name used to identify this product","verbs":["POST","PUT","GET"]} | [optional] |
| description | String | {"description":"A description — for your benefit — of the product. For example: you could explain what service this product entitles a customer to.","verbs":["POST","PUT","GET"]} | |
| duration | Integer | {"description":"Number of length-measures which constitute the product's period.","verbs":["POST","PUT","GET"]} | |
| duration_period | String | {"description":"Measure describing the magnitude of the product's period.","verbs":["POST","PUT","GET"]} | |
| metadata | DynamicMetadata | [optional] | |
| trial | Integer | {"default":0,"description":"Number of trial-length-measures which constitute the product's trial period","verbs":["POST","PUT","GET"]} | |
| trial_period | String | {"default":"none","description":"Measure describing the magnitude of the product's trial period.","verbs":["POST","PUT","GET"]} | |
| product_type | String | {"default":"recurring","description":"The frequency of the product — either recurring or non-recurring.","verbs":["POST","PUT","GET"]} | |
| deleted | BOOLEAN | {"description":"","verbs":["GET"]} | [default to false] |
| start_date | DateTime | {"description":"","verbs":[]} | [optional] |
| payment_terms | Integer | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.