Interface: RecurringSubscription
Extends
Properties
address_id
address_id:
number
Unique numeric identifier for the address the subscription is associated with.
Inherited from
analytics_data
analytics_data:
AnalyticsData
An object used to contain analytics data such as utm parameters.
Inherited from
SubscriptionBase.analytics_data
cancellation_reason
cancellation_reason:
string
Reason provided for cancellation.
Inherited from
SubscriptionBase.cancellation_reason
cancellation_reason_comments
cancellation_reason_comments:
string
Additional comment for cancellation.
Inherited from
SubscriptionBase.cancellation_reason_comments
cancelled_at
cancelled_at:
string
The time the subscription was cancelled.
Inherited from
charge_interval_frequency
charge_interval_frequency:
number
The number of units (specified in order_interval_unit) between each Charge. For example, order_interval_unit=month and charge_interval_frequency=3, indicate charge every 3 months. Charges must use the same unit types as orders. Max: 1000
Overrides
SubscriptionBase.charge_interval_frequency
created_at
created_at:
string
The time the subscription was created.
Inherited from
customer_id
customer_id:
number
Unique numeric identifier for the customer the subscription is tied to.
Inherited from
expire_after_specific_number_of_charges
expire_after_specific_number_of_charges:
number
Set the number of charges until subscription expires.
Inherited from
SubscriptionBase.expire_after_specific_number_of_charges
external_product_id
external_product_id:
ExternalId
An object containing the product id as it appears in external platforms.
Inherited from
SubscriptionBase.external_product_id
external_variant_id
external_variant_id:
ExternalId
An object containing the variant id as it appears in external platforms.
Inherited from
SubscriptionBase.external_variant_id
has_queued_charges
has_queued_charges:
boolean
Retrieves true if there is queued charge. Otherwise, retrieves false.
Inherited from
SubscriptionBase.has_queued_charges
id
id:
number
Unique numeric identifier for the subscription.
Inherited from
include?
optionalinclude:object
Additional information as requested
address?
optionaladdress:Address
bundle_product?
optionalbundle_product:BundleProduct
bundle_selections?
optionalbundle_selections:BundleSelection
customer?
optionalcustomer:Customer
metafields?
optionalmetafields:Metafield[]
Inherited from
is_prepaid
is_prepaid:
boolean
Value is set to true if it is a prepaid item.
Inherited from
is_skippable
is_skippable:
boolean
Value is set to true if it is not a prepaid item
Inherited from
is_swappable
is_swappable:
boolean
Value is set to true if it is not a prepaid item and if in Customer portal settings swap is allowed for customers.
Inherited from
max_retries_reached
max_retries_reached:
boolean
Retrieves true if charge has an error max retries reached. Otherwise, retrieves false.
Inherited from
SubscriptionBase.max_retries_reached
next_charge_scheduled_at
next_charge_scheduled_at:
string
Date of the next charge for the subscription.
Overrides
SubscriptionBase.next_charge_scheduled_at
order_day_of_month
order_day_of_month:
number
The set day of the month order is created. Default is that there isn’t a strict day of the month when the order is created. This is only applicable to subscriptions with order_interval_unit:“month”.
Inherited from
SubscriptionBase.order_day_of_month
order_day_of_week
order_day_of_week:
number
The set day of the week order is created. Default is that there isn’t a strict day of the week order is created. This is only applicable to subscriptions with order_interval_unit = “week”. Value of 0 equals to Monday, 1 to Tuesday etc.
Inherited from
SubscriptionBase.order_day_of_week
order_interval_frequency
order_interval_frequency:
number
The number of units (specified in order_interval_unit) between each order. For example, order_interval_unit=month and order_interval_frequency=3, indicate order every 3 months. Max value: 1000
Overrides
SubscriptionBase.order_interval_frequency
order_interval_unit
order_interval_unit:
IntervalUnit
The frequency unit used to determine when a subscription’s order is created.
Overrides
SubscriptionBase.order_interval_unit
presentment_currency
presentment_currency:
string
The presentment currency of the subscription.
Inherited from
SubscriptionBase.presentment_currency
price
price:
string
The price of the item before discounts, taxes, or shipping have been applied.
Inherited from
product_title
product_title:
string
The name of the product in a store’s catalog.
Inherited from
SubscriptionBase.product_title
properties
properties:
Property[]
A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself.
Inherited from
quantity
quantity:
number
The number of items in the subscription.
Inherited from
sku
sku:
string
A unique identifier of the item in the fulfillment. In cases where SKU is blank, it will be dynamically pulled whenever it is used.
Inherited from
sku_override
sku_override:
boolean
Flag that is automatically updated to true when SKU is passed on create or update. When sku_override is true, the SKU on the subscription will be used to generate charges and orders. When sku_override is false, Recharge will dynamically fetch the SKU from the corresponding external platform variant.
Inherited from
status
status:
"active"
The status of the subscription. expired - This status occurs when the maximum number of charges for a product has been reached.
Overrides
updated_at
updated_at:
string
The date time at which the purchase_item record was last updated.
Inherited from
variant_title
variant_title:
string
The name of the variant in a shop’s catalog.