The subscription model object

A comprehensive list of the subscription model resource's attributes and relationships

A subscription model object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/subscription_models endpoint.
Fields
Field
Type
Description
type
string
subscription_models
id
string
The subscription model unique identifier
links.self
string
The subscription model endpoint URL
attributes.name
string
The subscription model's internal name.
attributes.strategy
string
The subscription model's strategy used to generate order subscriptions: one between 'by_frequency' (default) and 'by_line_items'.
attributes.frequencies
array
An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour).
attributes.auto_activate
boolean
Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true.
attributes.auto_cancel
boolean
Indicates if the created subscriptions will be cancelled in case the source order is cancelled, default to false.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.markets
array
The associated markets.
relationships.order_subscriptions
array
The associated order subscriptions.
relationships.attachments
array
The associated attachments.
meta.mode
string
The resource environment (can be one of test or live)

Field	Type	Description
type	`string`	`subscription_models`
id	`string`	The subscription model unique identifier
links.self	`string`	The subscription model endpoint URL
attributes.name	`string`	The subscription model's internal name.
attributes.strategy	`string`	The subscription model's strategy used to generate order subscriptions: one between 'by_frequency' (default) and 'by_line_items'.
attributes.frequencies	`array`	An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour).
attributes.auto_activate	`boolean`	Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true.
attributes.auto_cancel	`boolean`	Indicates if the created subscriptions will be cancelled in case the source order is cancelled, default to false.
attributes.created_at	`datetime`	Time at which the resource was created.
attributes.updated_at	`datetime`	Time at which the resource was last updated.
attributes.reference	`string`	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	`string`	Any identifier of the third party system that defines the reference code
attributes.metadata	`object`	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.markets	`array`	The associated markets.
relationships.order_subscriptions	`array`	The associated order subscriptions.
relationships.attachments	`array`	The associated attachments.
meta.mode	`string`	The resource environment (can be one of `test` or `live`)

Subscription models

Create a subscription model

Last modified 6mo ago