Subscriptions

Retrieve the available Subscriptions in HubSpot.

Table Specific Information

In HubSpot, subscriptions represent customer subscriptions for products or services. Subscription records help track recurring revenue, subscription status, and customer subscription lifecycle management.

SELECT

When selecting subscriptions, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Subscriptions;
SELECT * FROM Subscriptions WHERE [Id] = '385815394826';
SELECT * FROM Subscriptions WHERE [Status] = 'active' OR [Name] = 'Premium Plan';

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Subscriptions WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Subscriptions WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Subscriptions WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Subscriptions WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

INSERT

INSERT INTO Subscriptions ([Name]) VALUES ('Premium Subscription')

UPDATE

UPDATE Subscriptions SET [Name] = 'Updated Subscription Name' WHERE ID = '12345'

DELETE

DELETE FROM Subscriptions WHERE ID = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Brands	String	False		False	The brands this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Allowed checkout fee IDs	Decimal	False		True	Stores up to two ids for the checkout fees that can be applied to the subscription at checkout
Allowed payment methods	String	False		False	The payment methods that can be used to pay the invoice
Annual recurring revenue	Decimal	True		True	The annual recurring revenue from the subscription.
Annual recurring revenue in company currency	Decimal	True		True	The annual recurring revenue from the subscription, in your company's currency
Automated sales taxes enabled	Bool	False		True	Whether or not automated sales taxes is enabled for subscription
Automatically email invoices	Bool	False		True	Determines if recurring invoices are automatically emailed to the customer on each billing date
Churn date	Date	False		True	Indicates when the subscription status has changed to INACTIVE or UNPAID.
Address types to collect	String	False		False	The types of addresses that are collected while paying the invoice.
Collection process	String	False		True	Describes the payment collection process for the subscription i.e. automatic vs manual (not yet supported)
Contact email	String	False		True	The email address of the contact associated to the subscription. This is the primary email address used for subscription related emails.
ContractManaged	Bool	False		True	Indicates whether or not a subscription is managed by a billing-enabled contract.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Currency code	String	False		False	The currency code of the subscription.
Subscription ID	Decimal	True		True	The internal reference id for a subscription. This is separate from the CRM object id for a subscription.
Invoice Comments	String	False		True	Comments to the invoice recipient
Invoice Creation	String	False		False	An indicator of whether a subscription is invoiced through HubSpot's Commerce Hub.
Status is active	Decimal	True		True	The calculated property value is 1 when the Subscription status is active or 0 otherwise.
Language	String	False		True	Language of the invoice
Last modification reason	String	False		True	Reason for last subscription edit
Subscription modified on	Datetime	False		True	The timestamp in epoch milliseconds for when a subscription was last modified.
Last modified by	String	False		True	The id of the user who last modified the subscription
Last payment amount	Decimal	False		True	The amount that was charged for the subscription during the most recent billing period.
Last Payment Date	Date	False		True	When the last payment processed for the subscription
Status of last payment	String	False		False	The status of the most recently initiated payment
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Locale	String	False		True	Locale of the invoice
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Monthly recurring revenue	Decimal	True		True	The monthly recurring revenue from the subscription.
Monthly recurring revenue in company currency	Decimal	True		True	The monthly recurring revenue from the subscription, in your company's currency
Name	String	False		True	The name of the subscription.
Net Payment Terms	Decimal	False		True	Refers to the period, expressed in days (e.g., Net 30), within which subscription invoices must be paid
Next payment amount	Decimal	False		True	The value to be processed on next payment date. If next payment date is null, the property is set to empty.
Next billing date	Date	False		True	The next billing date where the subscription will be invoiced. If the collection method value is automatic_payments, the subscription will be automatically charged. If the collection method value is manual_payments, an invoice will be created.
Number of completed payments	Decimal	False		True	The number of payments that have been successfully processed for the subscription.
Number of expected payments	Decimal	False		True	The number of total payments expected for the subscription.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Original buyer email address	String	False		True	The email address of the original buyer of the subscription
Owning Teams	String	False		False	The teams that are attributed to this record.
Payment Enabled	Bool	False		True	Indicates if a checkout link is included on invoices from subscriptions with a manual collection method
Payment method	String	False		True	The payment method on file for this subscription.
Payment method source at creation	String	False		False	Indicates where a payment method is collected when creating a subscription
Payment source	String	True		False	The object or tool that created the subscription.
Payment source ID	String	True		True	The unique ID for the object or tool that created the the subscription. This value is automatically set by HubSpot and may not be modified.
Processor	String	True		False	The processor for collecting subscription payments.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Recipient billing street address	String	False		True	The street address of the invoice recipient.
Recipient billing street address 2	String	False		True	Additional street address of the invoice recipient.
Recipient billing address source	String	True		False	Whether to use the recipient address on Company or Subscription object when making new Invoices
Recipient billing city	String	False		True	The city of the invoice recipient.
Recipient billing country	String	False		True	The country of the invoice recipient.
Recipient billing country code	String	False		True	The country code of the invoice recipient.
Recipient billing state/region	String	False		True	The state or region of the invoice recipient.
Recipient billing postal code	String	False		True	The postal or zip code of the invoice recipient.
Recipient company street address	String	True		True	The address of the recipient's company or organization.
Recipient company street address 2	String	True		True	Additional address of the recipient's company or organization.
Recipient company city	String	True		True	The city of the recipient's company or organization.
Recipient company country	String	True		True	The country of the recipient's company or organization.
Recipient company state/region	String	True		True	The state or region of the recipient's company or organization.
Recipient company postal code	String	True		True	The postal or zip code of the recipient's company or organization.
End date	Date	False		True	The date the subscription will end.
Recurring billing frequency	String	False		False	How often the customer is billed for the subscription.
Start date	Date	False		True	The date the subscription is scheduled to start (which is the day of the first payment).
Shared teams	String	True		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	True		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Status	String	False		False	The status of the subscription.
Store payment method at checkout	Bool	False		True	Allow customers to store their payment method at checkout.
Tax ID	String	False		False	The account tax IDs listed on the generated invoice. The tax ID includes a tax ID type and a tax ID number. Valid tax ids are managed in invoice settings.
Total collected amount	Decimal	False		True	The total amount collected from the subscription. The amount is in the currency of the subscription.
Total Remaining Amount	Decimal	True		True	The total amount remaining to be collected for subscriptions with a fixed number of payments. The amount is in the currency of the subscription.
Unique creation key	String	True		True	Unique property used for idempotent creates
Update payment method link	String	True		True	Link to update payment method on this subscription
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Subscription owner	String	False		True	The owner of the subscription.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

Code Assist MCP for HubSpot