BundlePurchaseItem
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
cancellation_reason
cancellation_reason:
string
Reason provided for cancellation.
Inherited from
Subscription.cancellation_reason
cancellation_reason_comments
cancellation_reason_comments:
string
Additional comment for cancellation.
Inherited from
Subscription.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
Inherited from
Subscription.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
Subscription.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
Subscription.external_product_id
external_variant_id
external_variant_id:
ExternalId
An object containing the variant id as it appears in external platforms.
Inherited from
Subscription.external_variant_id
has_queued_charges
has_queued_charges:
boolean
Retrieves true if there is queued charge. Otherwise, retrieves false.
Inherited from
Subscription.has_queued_charges
id
id:
number
Unique numeric identifier for the subscription.
Inherited from
include?
include?:
Object
Additional information as requested
Type declaration
address?
address?:
Address
bundle_product?
bundle_product?:
BundleProduct
bundle_selections?
bundle_selections?:
BundleSelection
customer?
customer?:
Customer
metafields?
metafields?:
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
items
items:
BundleSelectionItem
[]
max_retries_reached
max_retries_reached:
boolean
Retrieves true if charge has an error max retries reached. Otherwise, retrieves false.
Inherited from
Subscription.max_retries_reached
next_charge_scheduled_at
next_charge_scheduled_at:
string
Date of the next charge for the subscription.
Inherited from
Subscription.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
Subscription.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
Subscription.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
Inherited from
Subscription.order_interval_frequency