HubSpot: Commerce subscriptions schemas

← Commerce subscriptions operations · All schemas

Archive multiple subscription objects in a single request — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing the ID of a CRM object to be processed. This property is required.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

Referenced models: Archive a batch of contacts — request body — body inputs item

Batch create subscription objects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of objects to be created, where each object follows the SimplePublicObjectBatchInputForCreate schema.
inputs[]	Model	Each item	Expand Batch create subscription objects — request body — body inputs item

Referenced models: Batch create subscription objects — request body — body inputs item

Batch create subscription objects — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations for the objects being created. Each association links the object to another object using a specified association type.
associations[]	Model	Each item	Expand Create a new subscription object — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. This defines the attributes of the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create a new subscription object — request body — body associations item

Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string denoting the category of the error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about individual errors.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Subscriptions Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs that provide additional context or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items that represent the results of the batch operation.
results[]	Model	Each item	Expand Update a subscription — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Update a subscription — response body

Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Subscriptions Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of standard errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs containing documentation or additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Update a subscription — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Update a subscription — response body

Create a new subscription object — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link this object to other objects. Each association is defined by a 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create a new subscription object — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create a new subscription object — request body — body associations item

Create a new subscription object — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Create a new subscription object — request body — body associations item to
types	array	Required within parent	An array of association specifications, each defining the type of association between the objects. Each item in the array is a reference to the 'AssociationSpec' schema.
types[]	Model	Each item	Expand Create — calls create Call — request body — body associations item types item

Referenced models: Create — calls create Call — request body — body associations item types item, Create a new subscription object — request body — body associations item to

Create a new subscription object — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for the public object. It is a string that serves as a reference to the specific object within the CRM.

GDPR Delete — commerce Subscriptions gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	An optional property that specifies the unique property name used to identify the object, such as 'email'. If provided, the object will be identified by this property instead of the default object ID.
objectId	string	Required within parent	The unique identifier of the object to be deleted. This is a required field and must be a string.

List associations — commerce Subscriptions get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
paging	Model	Optional	Expand Retrieve a list of subscription objects — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object contains details about the associated object and the labels applied to the association.
results[]	Model	Each item	Expand List associations — commerce Subscriptions get Associations By To Object Type — response body — results item

Referenced models: Retrieve a list of subscription objects — response body — paging, List associations — commerce Subscriptions get Associations By To Object Type — response body — results item

List associations — commerce Subscriptions get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association types, each with a label, that define the relationship between the objects. Each item in the array is an AssociationSpecWithLabel object.
associationTypes[]	Model	Each item	Expand List associations — commerce Subscriptions get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object to which the association is made. It is a string.

Referenced models: List associations — commerce Subscriptions get Associations By To Object Type — response body — results item association Types item

List associations — commerce Subscriptions get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	A string representing the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the type ID of the source object in the association.
label	string	Optional	A string that provides a label for the association, offering a descriptive name for the relationship.
toObjectTypeId	string	Optional	A string representing the type ID of the target object in the association.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer that uniquely identifies the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Perform a batch upsert operation on subscription objects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of objects to be upserted, each represented by a SimplePublicObjectBatchInputUpsert. This property is required.
inputs[]	Model	Each item	Expand Perform a batch upsert operation on subscription objects — request body — body inputs item

Referenced models: Perform a batch upsert operation on subscription objects — request body — body inputs item

Perform a batch upsert operation on subscription objects — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the CRM object.
idProperty	string	Optional	A string specifying the name of a property that uniquely identifies the object type.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the property values for the CRM object. Each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object has been archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operation that created or updated this object.
properties	object	Required within parent	A map of property names to their current values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including historical data. Each value is an array of objects containing the value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Update a subscription — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Update a subscription — response body — properties With History value item

Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Subscriptions Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the objects that were upserted in the batch operation.
results[]	Model	Each item	Expand Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Subscriptions Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the objects that were successfully upserted during the batch operation.
results[]	Model	Each item	Expand Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch create subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Perform a batch upsert operation on subscription objects. — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Retrieve a batch of subscription objects by I Ds — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	A string representing the name of a property whose values are unique for this object type. This is optional and can be used to identify objects by a unique property value instead of the internal ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of the object to be read. These IDs are used to identify the objects for which the properties and historical values are requested.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned for each object. If any specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings representing the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of contacts — request body — body inputs item

Retrieve a list of subscription objects — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand Retrieve a list of subscription objects — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its properties and associations.
results[]	Model	Each item	Expand Retrieve a subscription — response body

Referenced models: Retrieve a list of subscription objects — response body — paging, Retrieve a subscription — response body

Retrieve a list of subscription objects — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Retrieve a list of subscription objects — response body — paging next

Referenced models: Retrieve a list of subscription objects — response body — paging next

Retrieve a list of subscription objects — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token indicating the position after the last item on the current page. It is used as a cursor for fetching the next set of results.
link	string	Optional	A URL string that provides a direct link to the next page of results.

Retrieve a subscription — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. May be null if the object is not archived. Format: date-time
associations	object	Optional	A map of associated object types to their corresponding IDs, representing the associations of this object with others. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Retrieve a subscription — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this CRM object.
objectWriteTraceId	string	Optional	An identifier used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including historical values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Update a subscription — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL link to access this object in HubSpot.
warnings	array	Optional	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Retrieve a subscription — response body — associations value, Update a subscription — response body — properties With History value item

Retrieve a subscription — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search for CRM commerce subscriptions using specified criteria — response body — paging
results	array	Required within parent	An array of associated IDs, where each item represents an association with an ID and type.
results[]	Model	Each item	Expand Retrieve a subscription — response body — associations value results item

Referenced models: Retrieve a subscription — response body — associations value results item, Search for CRM commerce subscriptions using specified criteria — response body — paging

Retrieve a subscription — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the associated object. This is a string value.
type	string	Required within parent	The type of association between the objects. This is represented as a string.

Search for CRM commerce subscriptions using specified criteria — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token for pagination, indicating the position after which to start returning results.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group contains a set of filters.
filterGroups[]	Model	Each item	Expand Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied to the CRM objects.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results.
sorts[]	string	Each item

Referenced models: Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item

Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of Filter objects. Each Filter defines a specific condition to be applied in the search query. This property is required.
filters[]	Model	Each item	Expand Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item filters item

Referenced models: Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item filters item

Search for CRM commerce subscriptions using specified criteria — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string value used when the operator is 'BETWEEN' to specify the upper bound of the filter range.
operator	string	Required within parent	The operator used to compare the property value. Valid operators include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to filter by. This is a string value.
value	string	Optional	The specific value to filter for, represented as a string.
values	array	Optional	An array of string values used for operators that require multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search for CRM commerce subscriptions using specified criteria — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search for CRM commerce subscriptions using specified criteria — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Update a subscription — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search for CRM commerce subscriptions using specified criteria — response body — paging, Update a subscription — response body

Search for CRM commerce subscriptions using specified criteria — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve a list of subscription objects — response body — paging next
prev	Model	Optional	Expand Search for CRM commerce subscriptions using specified criteria — response body — paging prev

Referenced models: Retrieve a list of subscription objects — response body — paging next, Search for CRM commerce subscriptions using specified criteria — response body — paging prev

Search for CRM commerce subscriptions using specified criteria — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string representing the cursor token used to retrieve the previous set of results in a paginated response.
link	string	Optional	A string containing the URL link to access the previous page of results.

Update a subscription — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's new value. All provided properties will be updated on the object. Additional keys: see wildcard field
properties.*	string	Additional keys

Update a subscription — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object has been archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for write operations on this object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, where each value includes a timestamp and the source of the value. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Update a subscription — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Update a subscription — response body — properties With History value item

Update a subscription — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string representing the unique identifier of the source.
sourceLabel	string	Optional	A string providing a label or description for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	A string representing the value at the given timestamp.

Update multiple subscriptions in a batch — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput items, each containing the properties of a CRM object to be updated. This array is required.
inputs[]	Model	Each item	Expand Update multiple subscriptions in a batch — request body — body inputs item

Referenced models: Update multiple subscriptions in a batch — request body — body inputs item

Update multiple subscriptions in a batch — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	A string representing the unique identifier for the object. This is used to specify which object is being referenced or modified.
idProperty	string	Optional	A string representing the name of a property whose values are unique for this object type. This is used to identify the object by a unique property value instead of the default ID.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. This is used to define the properties of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys