Subscription Object Reference

Overview

A subscription that has been purchased by a customer

Property Value
API Name s_c__Subscription__c
Label Subscription
Plural Label Subscriptions
Type Custom Object

Fields

Field Label API Name Type Required Description
[Future] Balloon Price s_c__Balloon_Price__c Currency(18,2) No [Feature not yet available] If present this amount is added to the final payment of the Subscription
Billing Delay Length s_c__Billing_Delay_Length__c Number(5,0) No Number of Billing_Delay_Unit__c durations after the Renewal Date to delay before charging the subscription. This is useful if you need to run an automated or manual process to update the period subscription charge before invoicing.
Billing Delay Unit s_c__Billing_Delay_Unit__c Picklist No The unit of measure for the Billing_Delay_Length__c for the subscription.
Cancelled Date s_c__Cancelled_Date__c DateTime No Date the Subscription was cancelled. If a future date is used the Subscription will continue being charged up to that date. Ideally this should match the Subscription Period. E.g. if the Subscription is charged on the 15th of the month, the Cancellation Date should be the 15th
Charge Payments s_c__Charge_Payments__c Checkbox No If checked true, StoreConnect will attempt to charge payments for this subscription. Set to false if payments are being handled by an external system or manually added
Contact s_c__Contact_Id__c Lookup (Contact) Yes The Contact who ordered this Subscription.
Delinquent Date s_c__Delinquent_Date__c DateTime No Date that charging payment first failed for this Subscription. This is cleared whenever a payment succeeds. If subsequent payments fail, this will be the date of the first failed payment
Delinquent Order s_c__Delinquent_Order_Id__c Lookup (Order) No The most recent failed order associated with this subscription that requires retry processing.
Delinquent Reason s_c__Delinquent_Reason__c LongTextArea(32768) No If a payment failed, this will contain the most recent error message returned by the payment provider (e.g. card expired)
End Date s_c__End_Date__c DateTime No The date the Subscription is scheduled to end.
Full Price s_c__Full_Price__c Currency(18,2) No The total value over the full term of the subscription. For Evergreen subscriptions, this will be the same as Period_Price__c. For Fixed-term subscriptions it will be Period_Price__c x Period_Count__c.
Last Processed At s_c__Last_Processed_At__c DateTime No The date/time when this subscription was last processed by StoreConnect. Used to prevent duplicate processing on the same day.
Last Validation At s_c__Last_Validation_At__c DateTime No The date/time when this subscription was last validated.
Next Billing Date s_c__Next_Billing_Date__c DateTime No The next date the payment will be charged. This is updated whenever a payment is taken successfully based on the Next Renewal Date plus any Billing Delay. If a Subscription is delinquent this may be a past date.
Next Renewal Date s_c__Next_Renewal_Date__c DateTime No Contains next date the Subscription renews. It is updated each time the subscription is processed based on the Period Length and Period Unit.
Original Order s_c__Order_Id__c Lookup (Order) Yes The Order that created this Subscription originally. A single order during checkout might have several subscription products, each with their own terms or price, during checkout, this will create a single order record and a subscription record per subscription product with each subscription record related to the appropriate order line item.
Payment Provider s_c__Payment_Provider_Id__c Lookup (s_c__Payment_Provider__c) No The Payment Provider that will be used for charging payments. This will be the same provider that was used on the initial Order
Payment Source Expiry s_c__Payment_Source_Expires_At__c Date No The date the Payment source (e.g. Credit Card) expires.
Payment Source Identifier s_c__Payment_Source_Identifier__c Text(255) No The obscured identifier for the source of Payments (e.g. last 4 digits of Credit Card)
Payment Token s_c__Payment_Token__c Text(255) No Token used by Payment_Provider__c for charging payment.
Term Count s_c__Period_Count__c Number(18,0) No This is the number of periods for the duration of the subscription. For a 12 month fixed-term subscription where Period_Type is "month", Period Count would be 12. For an evergreen subscription it will be 1.
Term Length s_c__Period_Length__c Number(18,0) No Number of the Period_Type__c durations between each payment, e.g. if Period_Type__c = "days", then "14" here would be fortnightly.
Term Price s_c__Period_Price__c Currency(18,2) Yes Price charged for the next subscription payment.
Term Unit s_c__Period_Type__c Picklist No Unit of of the Subscription period, e.g. "month" with Period_Length__c = 3 would charge the customer every 3 months
Product s_c__Product_Id__c Lookup (Product2) No The product the customer has subscribed to.
Renewal Order Date s_c__Renewal_Order_Date__c DateTime No The date the renewal order will be created. If empty, renewal order will only be created when the renewal is processed.
Renewal Order s_c__Renewal_Order_Id__c Lookup (Order) No The next order for this Subscription.
[Future] Setup Price s_c__Setup_Price__c Currency(18,2) No [Feature not yet available] If present this amount is added to the first payment of the Subscription.
Skip Processing s_c__Skip_Processing__c Checkbox No Controls whether processing of the Subscription will be skipped for each billing interval cycle.
Start Date s_c__Start_Date__c DateTime Yes The date the Subscription will be considered active and will be processed again based on Next Billing Date.
Suspended Date s_c__Suspended_Date__c Date No Date the Subscription was suspended. If a future date is used the Subscription will continue being charge up to that date. Ideally, this should match the Subscription Period. E.g. if the Subscription is charged on the 15th of the month, the Suspended Date should be the 15th.
Type s_c__Type__c Picklist No Type__c defines what type of Subscription this is, either an Evergreen or Fixed-Term.
Validation Error Messages s_c__Validation_Error_Messages__c LongTextArea(131072) No Any validation errors detected with this subscription.
Validation Status s_c__Validation_Status__c Picklist No Indicates whether this subscription has passed validation checks for payment processing.
StoreConnect External ID s_c__sC_Id__c Text(36) No StoreConnect External ID, do not modify in Salesforce

Relationships

Field Type Related Object Relationship Name
s_c__Contact_Id__c Lookup Contact Subscription_Contact
s_c__Delinquent_Order_Id__c Lookup Order Delinquent_Subscription_Order
s_c__Order_Id__c Lookup Order Subscription_Order
s_c__Payment_Provider_Id__c Lookup s_c__Payment_Provider__c Payment_Provider
s_c__Product_Id__c Lookup Product2 Subscription_Product
s_c__Renewal_Order_Id__c Lookup Order Subscription_Renewal_Order