Available tags
applied_promotion
Applied promotion
active
Indicates if this applied promotion is active
amount_used_including_tax_cents
Indicates if the amount used including tax
created_at
The date and time when the applied promotion was created.
deactivate_after_amount_including_tax_cents
The amount after which the promotion should get deactivated on a customer
deactivate_after_times
After how many times this promotion is "used up" for a customer
deactivation_strategy
Which mechanism will be used to deactivate the applied promotion
discount_code
The discount code that applied this promotion
id
ID of the applied promotion
next_order_discount_percentage
The effective percentage discount for the subscription's next order. Only available for applied order discount promotions.
promotion
promotion_id
The promotion ID that the applied promotion is related to
subscription_id
The subscription ID that the applied promotion is related to.
times_used
Indicates how many times this promotion was used
updated_at
The date and time when the applied promotion was updated.
asset
An asset representing a physical device, product, or something else that can be in the possession of a subscription.
external_number
The external number of the asset.
id
The ID of the asset.
internal_number
The internal number of the asset.
notes
Notes recorded about the asset.
product (product)
purchase_price
The current purchase price to the customer will pay to purchase the asset.
status
Status of the asset. Possible values: available, in_refurbishment, at_customer, purchased, scrapped, lost.
asset_ownership
An ownership record for an asset assigned to a subscription.
asset (asset)
asset_description
The human-readable asset description.
asset_ownership
asset_ownership_id
The ID of the asset ownership.
purchase_offer_url
The URL that creates an asset purchase offer and continues to checkout.
purchase_price
The purchase price formatted with currency symbol.
purchase_price_cents
The purchase price in cents.
churn_request
A cancellation or pause request and how it was resolved.
created_at
The date and time the churn request was created.
feedback
The free-text feedback the customer left, if any.
flow
Whether the request was raised while cancelling or pausing. Possible values: cancellation, pause.
follow_up_action
The follow-up action (win-back offer) chosen by the customer. Possible values: pause_subscription, skip_next_order, offer_discount, change_plan, snooze_order, content_retention, kept, custom_retention, cancel.
id
The ID of the churn request.
reason_description
The default customer-facing text configured for the recorded reason, if any, without locale translations.
reason_id (integer)
The database ID of the selected churn reason, or nil before a reason is selected. Use this stable ID for reason-specific conditions; id identifies the request itself.
reason_title
The internal Reporting title of the recorded reason, if any, not its customer-facing text.
status
The status of the churn request. Possible values: initiated, prevented, completed.
updated_at
The date and time the churn request was last updated.
collection_case
A collection case.
case_number
The case number of the collection case.
case_type
The collection case type. Possible values: intrum, manual.
created_at
The date and time the collection case was created.
id
ID of the collection case.
invoices ([invoice])
project_id
The project id of the collection case.
status
The status of the collection case. Possible values: open, closed.
updated_at
The date and time the collection case was last updated.
contract_term_event
A contract term event.
consumed_at
The date when this contract term event was consumed.
event_type
The contract term event type.
invoice
The invoice processed at this contract term event.
subscribed_plan
The subscribed plan for which this contract term is generated.
customer_feedback
Customer feedback.
comments
The given feedback.
created_at
The date and time when the feedback was given.
feedback_type
The type of customer feedback. Possible values: cancellation, other, customer_satisfaction.
id
ID of the customer feedback.
subscription_id
The subscription ID that the feedback is related to.
updated_at
The date and time when the feedback was updated.
discount_code
A discount code that can be used at signup
code
The code of the discount code.
created_at
The date and time when the discount code was created.
id
The ID of the discount code.
updated_at
The date and time when the discount code was updated.
extra_field_answer
Extra field answer details.
extra_field_id
The ID of the extra field.
formatted_value
The formatted value of the extra field answer.
id
The ID of the extra field answer.
name
The name of the extra field.
parameterized_name
The parameterized name of the extra field.
invoice
An invoice.
amount
Total amount including taxes.
amount_price
The total amount including taxes with currency symbol. Example: €12,50.
amount_price_cents
The total amount including taxes in cents.
collection_case
An optional collection case attached to this invoice.
created_at
DateTime the invoice was created at.
credited_invoice_id
ID of the invoice this invoice serves as a credit invoice for.
currency
Currency of the invoice.
currency_symbol
The currency symbol for the invoice.
description
The description of the invoice.
id (integer)
invoice_line_items ([invoice_line_item])
invoiced_at
DateTime the invoice was invoiced at.
locale
number
The formatted financial sequential number of the invoice.
order_id
Id of the order this invoice is related to.
original_invoice (invoice)
original_invoice_id
ID of the invoice this invoice serves as a credit invoice for.
overdue
Whether the invoice is overdue.
pay_now_url
The URL to the page where the customer can view and immediately pay for this invoice.
pay_now_url_for_invoice
payment (payment)
pending_retries?
If there are currently any payments in progress for this invoice.
pending_retries_for_invoice?
project
shopify_order_id
The Shopify order ID associated with this invoice.
shopify_subscription_billing_attempt_id
The Shopify subscription billing attempt ID associated with this invoice.
status
The invoice payment status as human-readable friendly string. Possible values: Open, Cancelled, Pending, Expired, Paid, Paid Out, Failed, Charged back, Refunded, Partially Refunded, Partially Paid.
status_code
The invoice payment status as underscored string. Possible values: open, cancelled, pending, expired paid, paidout, failed, charged_back, refunded, partially_refunded, partially_paid.
status_translated
The invoice payment status as localized string. Useful for easy display in emails and other communication.
subscription
invoice_line_item
A line item on an invoice.
amount_excluding_tax_cents
The amount of the line item excluding taxes, in cents.
amount_including_tax_cents
The amount of the line item including taxes, in cents.
billing_period_ends_at
The end date and time of the billing period of the invoice line item.
billing_period_starts_at
The start date and time of the billing period of the invoice line item.
description
The description or text on the line item.
effective_amount_excluding_tax
Effective unit price excluding tax, corrected based on invoice discount
effective_amount_excluding_tax_cents
Effective unit price excluding tax cents, corrected based on invoice discount
effective_amount_including_tax
Effective unit price including tax, corrected based on invoice discount
effective_amount_including_tax_cents
Effective unit price including tax cents, corrected based on invoice discount
id
ID of the line item.
invoice_line_item
line_item_type
The line item type of the invoice line item. Possible values: subscription, product, shipping, discount, credit, manual_invoice, promotion:, initial, asset_purchase.
locale
metadata
Metadata on the invoice line item in key-value pairs.
product (product)
quantity
The quantity of the line item.
tax_percentage
The tax percentage of the line item.
total_amount_excluding_tax
The total amount of the line item excluding taxes.
total_amount_excluding_tax_cents
The total amount of the line item excluding taxes, in cents.
total_amount_including_tax
The total amount of the line item including taxes. Example: €12,20
total_amount_including_tax_cents
The total amount of the line item including tax, in cents. Example: 1220
total_effective_amount_excluding_tax_cents
Total effective amount excluding tax, corrected based on invoice discount
total_effective_amount_including_tax_cents
Total effective amount including tax, corrected based on invoice discount
total_tax_amount
The total tax amount of the line item.
total_tax_amount_cents
The total tax amount of the line item, in cents.
invoice_reminder
An invoice reminder
final_reminder
The final invoice reminder
reminder_number
The number of invoice reminder.
klaviyo_profile
Klaviyo profile data for the subscription email address. Requires the Firmhouse Klaviyo app to be connected with OAuth.
properties (hash)
segment_ids ([string])
segment_names ([string])
segments ([hash])
offer
An offer.
accept_url
The URL to directly accept and immediately pay for the offer.
created_at
DateTime the offer was created at.
details_url
The URL to the page where the customer can view and pay for the offer.
expires_at
DateTime the offer expires at.
failure_url
An optional URL to redirect the customer if offer has expired"
id
The ID of the offer.
invoice (invoice)
invoice_id
Id of the invoice associated with this offer.
locale
offer_type
The offer type as underscored string. Possible values: general, asset_purchase, plan_switch.
plan (plan)
status
The offer status as underscored string. Possible values: pending, completed.
subscription
subscription_id
Id of the subscription this offer is made for.
success_url
An optional URL to redirect the customer after successful payment."
order
An order.
address
Shipping address line on the order.
amount
The total amount of the order.
amount_cents
Total amount of the order, in cents.
amount_currency
Currency of the amount on the order.
applied_promotions ([applied_promotion])
cancel_url
URL where the customer can cancel the order.
city
Shipping city on the order.
company_name
Shipping company name on the order.
confirm_url
URL where the customer can confirm the order.
country
Shipping country on the order.
created_at
Date and time when the order was created.
discount
The total discount on the order, including taxes.
discount_cents
The discount on the order, in cents.
discount_currency
The currency of the discount on the order.
discount_excl_tax
The total discount on the order, excluding taxes.
discount_excl_tax_cents
display_date
The localized date shown for the order in customer-facing lists.
district
Shipping district on the order.
empty_track_and_trace_sent_at
from_address
From address of the merchant on the order.
fulfilled_at
The date and time on which the order was fulfilled
full_name
house_number
Shipping house number on the order.
id (integer)
invoice (invoice)
invoice_id
The ID of the invoice that was generated for the order.
last_name
Shipping last name on the order.
minimum_order_amount_reached?
Whether the configured minimum amount is reached for the order.
name
Shipping first name on the order.
order_announcement_sent_at
The date and time when the order announcement was sent to the customer.
order_confirmation_sent_at
The date and time when the order confirmation was sent to the customer.
order_lines ([order_line])
payment_id
ID of the first payment that was used to pay for the order.
phone_number
Shipping phone number on the order.
products ([product])
reminder_sent_at
The date and time when the most recent order reminder was sent.
self_service_url
URL to view this order in the self-service center.
send_reminder_on
The date when the a reminder for confirming the order will be sent.
shipment_date
The date when the order was generated.
shipping_address_lines
The formatted shipping address split into individual lines.
shipping_costs
The shipping costs on the order, including taxes.
shipping_costs_cents
The shipping costs on the order, in cents.
shipping_costs_currency
The currency of the shipping costs on the order.
shipping_costs_excl_tax
The shipping costs on the order, excluding taxes.
shipping_costs_excl_tax_cents
The shipping costs on the order, excluding taxes in cents.
shopify_fulfillment_order_id
The Shopify fulfillment order ID associated with this order.
shopify_id
The Shopify order ID associated with this order.
shopify_order_status_page_url
URL to view the order on the customer's Shopify order status page. Fetches the URL from the Shopify API. Cached for 1 hour. Times out after 1 second.
snooze_url
URL where the customer can snooze the order.
state
Shipping state on the order.
status
The status of the order. Possible values: pending, confirmed, snoozed, cancelled, fulfilled, draft.
status_translated
The status of the order as a localized string.
subscription_id
ID of the subscription that the order was generated for.
subtotal
The sum of the order lines on the order, including taxes.
subtotal_excl_tax
The sum of the order lines on the order, excluding taxes.
total_tax
The total amount of tax on the order.
total_tax_cents
track_and_trace_code
The track and trace code for the order.
tracking_codes
An array of all tracking codes for the order.
updated_at
Date and time when the order was last updated.
zipcode
Shipping zipcode or postal code on the order.
order_line
A line on an order.
amount_excluding_tax
Amount excluding tax per each unit
amount_excluding_tax_cents
Amount excluding tax per each unit, in cents
amount_including_tax
Amount including tax per each unit
amount_including_tax_cents
Amount including tax per each unit, in cents
event_properties
Product display data for event payloads, using the order line's name and quantity.
locale
metadata
Metadata on the order line line item in key-value pairs.
ordered_product (ordered_product)
product (product)
product_id
product_sku
The product SKU.
product_title
The product title.
product_type
The product type.
quantity
The quantity of the order line.
shopify_product_id
shopify_variant_id
tax_percentage
The tax percentage of the order line
total_amount_excluding_tax
Total amount excluding tax
total_amount_excluding_tax_cents
Total amount excluding tax, in cents
total_amount_including_tax
Total amount including tax
total_amount_including_tax_cents
Total amount including tax, in cents
total_tax_amount
Total tax amount
total_tax_amount_cents
Total tax amount, in cents
ordered_product
Information about a product that is or was on a subscription.
custom_price_cents
The custom price in the currency's smallest subunit if a different price is set for this customer.
firmhouse_metadata_url
URL to read and update allowlisted Firmhouse metadata for this ordered product.
grace_cancellation_ends_at
The date and time at which the grace cancellation period ends.
grace_cancellation_period
The grace cancellation period of the ordered product in grace cancellation period units.
grace_cancellation_unit
The grance cancellation period unit of the ordered product. Possible values: days, weeks, months, years
id
The ID of the ordered product.
in_grace_cancellation
Wether the ordered product is in the grace cancellation period.
in_maximum_commitment
Wether the ordered product is in the maximum commitment period.
in_minimum_commitment
Whether the ordered product is in the minimum commitment period.
instalment_current_number
The current Shopify based instalment number for the ordered product.
instalment_original_product (product)
instalment_total_count
The total number of instalments for the ordered product.
interval
The interval in interval unit of measure at which the ordered product is shipped. The product interval is used if this is empty.
interval_unit_of_measure
The unit of measure for the interval at which the ordered product is shipped. Possible values: default (take unit from associated product), days, weeks, months. The product unit of measure is used if this is set to default.
localized_title
The localized title of the product subscribed via the ordered product.
maximum_commitment_ends_at
The date and time at which the maximum commitment of the ordered product ends.
maximum_commitment_period
The maximum commitment period of the ordered product in maximum commitment units.
maximum_commitment_unit
The maximum commitment unit of the ordered product in which the maximum commitment period is counted. Possible values: days, weeks, months, years, billing_cycles
metadata
Metadata on the ordered product in key-value pairs.
minimum_commitment_ends_at
The date and time at which the minimum commitment of the ordered product ends.
minimum_commitment_period
The minimum commitment period of the ordered product in minimum commitment units.
minimum_commitment_unit
The minimum commitment unit of the ordered product in which the minimum commitment period is counted. Possible values: days, weeks, months, years, billing_cycles
out_of_stock
Whether the ordered product is out of stock. Only true when the project enforces Shopify stock and the underlying product is out of stock. Themes can use this to render an "Out of stock" badge.
plan (plan)
price
The price of the ordered product formatted with currency symbol.
price_cents
The price of the ordered product in the currency's smallest subunit.
product (product)
product_id
The ID of the product that is subscribed to via the ordered product.
quantity
The quantity of the ordered product.
recurring (boolean)
replace_url (string)
URL where the customer can replace this ordered product with another product in the customer portal. Apply the ssc_hotlink filter in customer email to open this page without requiring a full login.
shipment_date
The next date an order will be generated with this ordered product.
shopify_subscription_line_id
The Shopify subscription line ID associated with this ordered product (only for native subscriptions).
status (string)
swap_variant_url
URL where the customer can swap this ordered product for another variant in the customer portal.
title
The title of the product subscribed via the ordered product.
total_ordered
payment
A payment.
amount_cents
amount_known?
amount_price
attempts_count
currency
description
failure_reason
failure_reason_translated
id (integer)
invoice
most_recent_attempt (payment)
pay_now_url
payment
payment_id
payment_provider (string)
payment_provider_payment_method (string)
payment_type
payment_type_translated
refunds
retry_attempt
retry_attempt?
retry_payment_url
scheduled_retry_on
shopify_native_payment (boolean)
shopify_subscription_billing_attempt_id
The Shopify subscription billing attempt ID associated with this payment (only for native subscriptions).
status
status_translated
token (string)
pickup_point
A pickup point for delivery.
address
The street address of the pickup point.
city
The city of the pickup point.
country
The country code of the pickup point.
created_at
The date and time when this pickup point was created.
district
The district of the pickup point.
house_number
The house number of the pickup point.
id
The database ID of the pickup point.
name
The name of the pickup point.
phone_number
The phone number of the pickup point.
provider
The provider of this pickup point (e.g., metapack).
provider_id
The provider's unique identifier for this pickup point.
updated_at
The date and time when this pickup point was last updated.
zipcode
The postal code of the pickup point.
plan
A plan customers can subscribe to.
id
image_url
initial_price
instalments
metadata
Metadata on the plan in key-value pairs.
monthly_price
name
plan
slug
subscription
product
A product.
available
cost_per_item
cost_per_item_cents
cost_per_item_excl_tax
created_at
display_image_url
The Shopify image, falling back to the uploaded product image.
id
image_file_name
in_stock
initial_shipment_delay
initial_shipment_delay_unit_of_measure
initial_shipment_delay_unit_of_measure_translated
interval
interval_unit_of_measure
interval_unit_of_measure_translated
localized_public_name
localized_title
mandatory
metadata
nth_product_free
price
price_cents
The price including tax in the subscription currency's smallest subunit.
price_excl_tax
price_excl_tax_cents
The price excluding tax in the subscription currency's smallest subunit.
product
product_image_url
project_id
ship_on_signup
shopify_image_url
shopify_product_id
shopify_product_title
shopify_product_url
shopify_public_product_url
shopify_variant_id
shopify_variant_title
sku
slug
stock
subscription
supplier
title
updated_at
promotion
Promotion
activated
If the promotion is activated
amount_cents
The amount cents to be discounted
auto_apply
If the promotion is automatically applied on signup
created_at
The date and time when the promotion was created.
deactivate_after_amount_including_tax_cents
The amount after which the promotion should get deactivated on a customer
deactivate_after_times
After how many times this promotion is "used up" for a customer
deactivation_strategy
Which mechanism will be used to deactivate the promotion
discount_type
The discount type either `percent` or `amount`
discountable_product_ids ([integer])
ends_at
The promotion is active until
id
ID of the promotion
localized_public_name
The public name shown to the customer in the current rendering locale
percent_discount
The percent discount to be applied
public_name
The public name shown to the customer
starts_at
The promotion is active from
title
Title of the given promotion
updated_at
The date and time when the promotion was updated.
promotional_offer
A currently eligible promotional offer available to a subscription.
accent_color
The merchant-selected accent color for this offer's presentation.
accent_foreground
A high-contrast foreground color for content placed on the accent color.
accept_hotlink_url
The public URL where the customer can review and accept the offer, with a Customer Portal hotlink that signs the customer in until the offer expires.
accept_url
The public URL where the customer can review and accept the offer.
accepted
accepted_at
The date and time at which the offer was accepted.
benefit
The snapshotted benefit applied by this offer.
benefit_label
The localized description of what the customer receives.
commitment
commitment?
Whether accepting the offer requires a commitment from the customer.
commitment_label
The localized description of the customer's commitment, when present.
commitment_snapshot
The snapshotted commitment applied by this offer, when present.
declined
description
The localized customer-facing offer description.
entry_point
The entry point where the offer was issued.
event_fields
Flat event fields for referencing this offer directly in email templates.
event_properties
Offer data for event payloads, with subscription-specific Customer Portal hotlinks. The same-day link lasts 24 hours; every link is capped at the offer's expiry.
expires_at
The date and time at which the offer expires.
id
The Firmhouse ID of an issued offer, or a stable definition reference for an in-memory offer.
offer_definition_id
The Firmhouse ID of the offer definition.
offer_definition_name
The internal name of the offer definition.
priority
The offer's matching priority. Lower numbers have a higher priority.
product
The single product featured by this offer, when one is involved.
reactivates_subscription (boolean)
Whether accepting the offer reactivates a stopped subscription or resumes a paused subscription.
slug
Stable identifier shared by all offers from this definition.
status
The current status. Eligible promotional offers have the pending status, or the rejected status when the offer definition allows customers to reconsider declined offers.
title
The localized customer-facing offer title.
upsell_product
The product and quantity included in an upsell offer, or nil for other offers.
referral_candy
ReferralCandy data for a subscription.
advocate_reward_discount
code
url
refund
A refund.
amount_cents
amount_price
id
payment
reason
refund
refunded_at
status
return_order
A return order.
desired_return_date
external_reference
external_status
external_url
id
reason
return_label_file_url
return_order
return_order_products
returned_on
status
tracking_code
tracking_url
service_channel
A service channel.
address
name
service_channel
slug
subscribed_plan
Object that represents how a subscription is subscribed to a plan.
activated_at
The date and time the plan subscription was activated.
billing_cycle_interval
billing_cycle_interval_period
The billing cycle interval in the billing cycle interval unit.
billing_cycle_interval_unit
The unit in which the billing cycle interval is measured.
deliveries_in_billing_cycle
The number of deliveries within one billing cycle. Returns 1 for non-prepaid plans.
delivery_cycle_interval_period
The delivery cycle interval in the delivery cycle interval unit.
delivery_cycle_interval_unit
The unit in which the delivery cycle interval is measured.
fixed_commitment_ends_at
The date and time at which the fixed commitment ends.
fixed_commitment_period
The fixed commitment period of the subscription in the fixed commitment period unit.
fixed_commitment_unit
The fixed commitment period unit of the subscription. Possible values: days, weeks, months, years
grace_cancellation_ends_at
The date and time at which the grace cancellation period ends.
grace_cancellation_period
The grace cancellation period of the subscription in grace cancellation period units.
grace_cancellation_unit
The grace cancellation period unit of the ordered product. Possible values: days, weeks, months, years
id
The ID of the subscribed plan object.
in_fixed_commitment_term
Wether the subscription is its fixed commitment term.
in_grace_cancellation
Wether the subscription is in the grace cancellation period.
in_maximum_commitment
Whether the subscription is in the maximum commitment period.
in_minimum_commitment
Whether the subscription is in the minimum commitment period.
maximum_commitment_ends_at
The date and time at which the maximum commitment of the subscription product ends.
maximum_commitment_period
The maximum commitment period of the subscription in maximum commitment units.
maximum_commitment_unit
The maximum commitment unit of the subscription in which the maximum commitment period is counted. Possible values: days, weeks, months, years, billing_cycles
minimum_commitment_ends_at
The date and time at which the minimum commitment of the subscription product ends.
minimum_commitment_period
The minimum commitment period of the subscription in minimum commitment units.
minimum_commitment_unit
The minimum commitment unit of the subscription in which the minimum commitment period is counted. Possible values: days, weeks, months, years
subscribed_plan
unconsumed_contract_term_event_count
The number of unconsumed prepaid billing cycles.
subscription
A subscription.
active_plan (plan)
add_product_url
URL where the customer can add an eligible product to their subscription.
address
Primary or shipping address line.
address2
Primary or shipping address additional address information (apartment, floor, etc.).
allowed_to_cancel?
Whether the subscription can be cancelled.
allowed_to_pause?
Whether the subscription can be paused.
allowed_to_resume?
Whether the subscription can be resumed.
allowed_to_skip?
Whether the upcoming order can be skipped for this subscription.
allowed_to_snooze?
Whether the upcoming order can be snoozed for this subscription.
allowed_to_switch_plan?
Whether the subscription can switch to another plan.
applied_promotions ([applied_promotion])
asset_ownerships ([asset_ownership])
asset_purchase_offers_blocked_by_outstanding_invoices
Whether asset purchase offers are blocked because the subscription has outstanding invoices.
assets ([asset])
bill_to_address
Billing address line. Returns the shipping address if different_billing_address is false.
bill_to_address2
Billing address additional address information (apartment, floor, etc.). Returns the shipping address2 if different_billing_address is false.
bill_to_city
Billing address city. Returns the shipping address city if different_billing_address is false.
bill_to_company_name
Billing address Company name of the customer. Returns the shipping address company name if different_billing_address is false.
bill_to_country
Billing address country. Two-letter country code. Returns the shipping address country if different_billing_address is false.
bill_to_full_address
Billing address field where address line and house number are combined. Returns the shipping address full address if different_billing_address is false.
bill_to_full_name
Billing address Full name of the customer. First name and last name merged into a single attribute. Returns the shipping address full name if different_billing_address is false.
bill_to_house_number
Billing address house number. Returns the shipping address house number if different_billing_address is false.
bill_to_last_name
Billing address Last name of the customer. Returns the shipping address last name if different_billing_address is false.
bill_to_name
Billing address First name of the customer. Returns the shipping address name if different_billing_address is false.
bill_to_phone_number
Billing address phone number. Returns the shipping address phone number if different_billing_address is false.
bill_to_salutation
Billing address Salutation of the customer. Sometimes used as gender. Possible values: mr, ms, mx. Returns the shipping address salutation if different_billing_address is false.
bill_to_state
Billing address state. Returns the shipping address state if different_billing_address is false.
bill_to_zipcode
Billing address zipcode or postal code. Returns the shipping address zipcode if different_billing_address is false.
cancel_subscription_url
URL where the customer can cancel their subscription in the self-service center.
cancellation_churn_request (churn_request)
cancellation_context
The context in which the subscription was cancelled. Possible values: normal, in_grace_cancellation_period forced_in_miminum_commitment, end_of_subscription, purchased_device
cancellation_reason
The cancellation reason title selected by the customer when cancelling.
cancellation_started_at
The date and time the cancellation for this subscription was initiated.
cancellation_url
URL where the customer can cancel their subscription.
cancelled_at
The date and time the subscription was cancelled.
city
Primary or shipping address city.
collection_cases ([collection_case])
company_name
Company name of the customer.
complete_churn_request_url
URL where a custom customer portal can POST a known reason to complete a churn request.
complete_your_signup_url
URL where the customer can complete their signup and initial payment, in case of a two-step signup flow.
confirmed_and_fulfilled_orders_count
The number of confirmed and fulfilled orders for the subscription.
country
Primary or shipping address country. Two-letter country code.
currency
The three-letter currency the subscription is billed in. Example: EUR or USD.
currency_subunit_to_unit
The number of smallest currency subunits in one unit. Example: 100 for EUR and 1 for HUF.
currency_symbol
The currency symbol the subscription is billed in. Example: € or $.
customer_feedbacks ([customer_feedback])
customer_id
customer_reference
Your reference field for this subscription.
delivery_method
The delivery method for this subscription (shipping or pickup_point).
different_billing_address
Whether the subscription has a different billing address than the shipping address.
edit_subscription_details_url
URL where the customer can edit their subscription details (address, payment method, etc.).
eligible_promotional_offers ([promotional_offer])
The email address of the subscription.
extra_fields
Array of extra fields for this subscription.
extra_fields_v2 ([extra_field_answer])
files ([file])
full_address
Primary or shipping address field where address line and house number are combined.
full_name
Full name of the customer. First name and last name merged into a single attribute.
house_number
Primary or shipping address house number.
id (integer)
imported_subscription_id
Your reference field back to an ID from a system where this subscription was imported from.
initial_invoice (invoice)
initial_or_recurring_invoices_count
The number of initial and recurring invoices that were invoiced so far for this subscription.
invoices ([invoice])
invoices_url
URL where the customer can view their invoices.
klaviyo_profile (klaviyo_profile)
last_name
Last name of the customer.
last_order_id
The ID of the most recently created order for this subscription.
latest_churn_request (churn_request)
latest_five_orders ([order])
locale
The two-letter code of the language of the subscription.
login_url
The URL that customers can go to to log into their self service center.
mandate_url
URL where the customer can find evidence of their SEPA Direct Debit mandate. (Only on Stripe)
marked_as_non_paying?
Whether the customer currently has problems with their payment method and is marked as non-paying.
marketing_opt_in_accepted?
Whether the subscription accepted your marketing opt-in or not.
metadata
Metadata on the subscription in key-value pairs.
monthly_amount
The monthly or recurring amount that was last calculated for the subscription. Example: €12,10.
monthly_amount_cents
The monthly or recurring amount in the currency's smallest subunit. Example: 1210 for EUR 12.10.
name
First name of the customer.
next_billing_date
The upcoming date the customer will be billed on. Only on plan-based projects.
next_order_preview (order)
next_payment_shopify_instalment?
Whether the upcoming/next payment is in a Shopify instalment cycle.
next_upcoming_products ([ordered_product])
not_purchased_asset_ownership_ids
An array of asset_ownership IDs that are not yet purchased.
on_prepaid_plan?
Whether the subscription is currently on a prepaid plan.
ordered_products ([ordered_product])
outstanding_amount
The total outstanding amount for this subscription.
pause_churn_request (churn_request)
pause_reason
The pause reason title recorded in the most recent finalized pause request.
pause_subscription_url
URL where the subscription can be paused.
paused_at
The date and time the subscription was paused.
paused_until
The date until which the subscription is paused for a fixed period (for example, a win-back offer). Blank when the subscription is paused indefinitely.
payment_method
The payment method currently active on the subscription.
payment_method_health_check (subscription_payment_method_health_check)
payment_method_summary
The payment method currently active on the subscription.
pending_cancellation_final_order_date
The estimated shipment date of the final order before a pending cancellation completes. Blank when the pending-cancellation timeline is unavailable or no orders remain.
pending_cancellation_remaining_orders_count
The number of orders that will ship before a pending cancellation completes. Blank when the pending-cancellation timeline is unavailable.
phone_number
Primary or shipping address phone number.
pickup_point (pickup_point)
planned_cancellation_date
The date the subscription is planned to be cancelled.
products ([product])
promotional_offer_event_fields
Flat offer properties, using the soonest-expiring offer when a definition has multiple eligible offers.
purchasable_asset_ownerships ([asset_ownership])
referral_candy (referral_candy)
referral_code
The referral code for this subscription.
rejected_at
The date and time the subscription was rejected.
resume_subscription_url
URL where the subscription can be resumed.
salutation
Salutation of the customer. Sometimes used as gender. Possible values: mr, ms, mx.
scheduled_orders_count
The number of scheduled future orders for the subscription.
segments ([subscription_segment])
shipping_notes
Primary or shipping address delivery instructions.
shopify_customer_id
The Shopify customer ID associated with this subscription.
shopify_subscription_contract_id
The Shopify subscription contract ID associated with this subscription.
signup_completed_at
The date and time the subscription completed their signup and initial payment.
skip_upcoming_order_url
URL where the customer can skip their upcoming order, if they have an upcoming order.
snooze_upcoming_order_url
URL where the customer can snooze their upcoming order, if they have an upcoming order. Append a comma-separated `snooze_options` query parameter with day counts to offer multiple dates, for example `?snooze_options=7,14,28`.
state
Primary or shipping address state.
status
The status of the subscription. Possible values: inactive, activated, cancelled, cancellation_in_progress, draft, rejected, pending_customer_completion, paused, stopped.
stopped_at
The date and time the subscription was stopped.
subscribed_plan (subscribed_plan)
subscription_acceptance_checks ([subscription_acceptance_check])
subscription_account (subscription_account)
subscription_selection_url
URL where the customer can switch between their subscriptions (multi-subscription view).
subscription_started_at
The date and time the subscription was activated and started.
switch_plan_url
URL where the subscription can switch to another plan.
token (string)
track_and_trace_code
update_payment_method_url
URL where the customer can update their payment method.
vat_number
The VAT number of the customer.
veriff_identification_url
URL where the customer can verify their identity.
zipcode
Primary or shipping address zipcode or postal code.
subscription_acceptance_check
A Subsription acceptance check.
id
The ID of the subscription acceptance check.
name
The name of the subscription acceptance check.
status
The status of the subscription acceptance check. Possible values: pending, accepted, rejected.
subscription_acceptance_check
veriff_session_id
The current Veriff session ID for Veriff identity verification acceptance checks.
subscription_account
A subscription account.
id
subscription_account
subscriptions ([subscriptions])
subscription_payment_method_health_check
A payment method health check for the subscription's current payment method.
checked_at
Date and time when the check ran.
expires_on
Expiry date observed by the check, when available.
health_check
payment_provider
Payment provider used by the check.
reason
Stable reason code reported by the check.
status
Status of the check. Possible values: healthy, unhealthy, unsupported, errored.
subscription_segment
The segment a subscription was added to.
external_id
The segment ID at its source.
id
The ID of the subscription segment.
name
The segment name.
source
The segment source.
workflow
A project workflow and its configured inputs.
description
enabled
Whether the workflow is enabled.
enabled?
id
inputs ([workflow_input])
The workflow inputs with their current configured values.
name
source
subscription
workflow
workflow_input
A configurable input on a workflow.
input
key
label
product (product)
The product selected for a product input.
required
Whether this input must be configured before the workflow can be published.
type
value
Filters
json_escape
Serializes a value as JSON. Use it without surrounding quotes when interpolating JSON templates.
Returns: string
Example:
input
Yes
json_get
Reads one top-level value from a JSON object string.
Returns: object
Example:
json_str
Yes
key
Yes
payment_method_name
Formats a payment method for display in customer-facing content.
Returns: string
Example:
payment_method
Yes
ssc_hotlink
Creates a signed Customer Portal link for the current subscription. Hotlink access is supported by product addition, product replacement, upcoming-order skip, and upcoming-order snooze actions. Other Customer Portal pages require a full-access login. The optional validity is an ISO 8601 duration and defaults to one week.
Returns: string
Example:
url
Yes
validity
No
with_veriff_return_url
Adds a signed return URL to a Veriff verification URL.
Returns: string
Example:
verification_url
Yes
return_url
Yes
Last updated
Was this helpful?