Subscription term data object specification for the Cratejoy Merchant API
A subscription term represents the cycle information associated with a given subscription. A sample call for viewing a shipment's fulfillments might be http://api.cratejoy.com/v1/subscriptions/{ID}/?with=term.
Properties
| Property | Filter | Edit | Type | Description |
|---|---|---|---|---|
| id | INT | Unique identifier | ||
| description | STRING | Seller-provided descripition of this subscription term | ||
| enabled | BOOL | Whether the term is set to be subscriber-visible or not. | ||
| name | STRING | Name of the term, e.g. "Month to Month" |
||
| num_cycles | INT | The number of rebill cycles in the term. E.g. 3 for a 3-month prepay, or 1 for a month-to-month subsription. |
||
| type | STRING | Always subscription_type_term |
RELATION PROPERTIES
| Property | Resource | Description | Filter? |
|---|---|---|---|
| image | Images | Images associated with the subscription term. | No |