Available tags

asset

An asset representing a physical device, product, or something else that can be in the possession of a subscription.

Properties

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.

The product this asset is an instance of.

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.

customer_feedback

Customer feedback.

Properties

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.

invoice

An invoice.

Properties

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

The ID of the invoice.

Array of the invoice line items on the invoice.

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.

The original invoice that this invoice serves as a credit invoice for.

original_invoice_id

ID of the invoice this invoice serves as a credit invoice for.

pay_now_url

The URL to the page where the customer can view and immediately pay for this invoice.

pay_now_url_for_invoice

The first payment attempt for this invoice.

pending_retries?

If there are currently any payments in progress for this invoice.

pending_retries_for_invoice?

project

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.

Properties

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.

The product associated with the line item.

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_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

Properties

final_reminder

The final invoice reminder

reminder_number

The number of invoice reminder.

order

An order.

Properties

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.

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.

district

Shipping district on the order.

empty_track_and_trace_sent_at

Date and time when an empty tracking code warning was last sent for the order.

from_address

From address of the merchant on the order.

fulfilled_at

The date and time on which the order was fulfilled

house_number

Shipping house number on the order.

id

ID of the order

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.

Array with the order lines on the order.

payment_id

ID of the first payment that was used to pay for the order.

phone_number

Shipping phone number on the order.

Products on this order based via its order lines.

reminder_sent_at

The date and time when the most recent order reminder was sent.

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_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.

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.

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.

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.

Properties

metadata

Metadata on the order line line item in key-value pairs.

The product associated with this order line.

product_sku

The product SKU.

product_type

The product type.

quantity

The quantity of the order line.

ordered_product

Information about a product that is active on a subscription.

Properties

custom_price_cents

The custom price of the ordered product in cents if a different price is set for this customer than the default price.

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.

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.

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

The plan this ordered_product is part of.

The product that is subscribed to via the ordered product.

product_id

The ID of the product that is subscribed to via the ordered product.

quantity

The quantity of the ordered product.

shipment_date

The next date an order will be generated with this ordered product.

title

The title of the product subscribed via the ordered product.

total_ordered

Total ordered so far as part of the current volume discount (Nth product for free) streak.

payment

A payment.

Properties

amount_price

attempts_count

description

failure_reason

failure_reason_translated

id

invoice

most_recent_attempt

pay_now_url

payment

payment_id

payment_type

payment_type_translated

refunds

retry_attempt

retry_payment_url

scheduled_retry_on

status

status_translated

token

plan

A plan customers can subscribe to.

Properties

id

image_url

initial_price

monthly_price

name

plan

slug

subscription

product

A product.

Properties

cost_per_item

cost_per_item_cents

cost_per_item_excl_tax

created_at

id

image_file_name

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

mandatory

metadata

nth_product_free

price

price_cents

price_excl_tax

price_excl_tax_cents

product

product_image_url

project_id

ship_on_signup

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

return_order

A return order.

Properties

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.

Properties

address

name

service_channel

slug

subscribed_plan

Object that represents how a subscription is subscribed to a plan.

Properties

activated_at

The date and time the plan subscription was activated.

billing_cycle_interval

The billing cycle interval in the billing cycle interval unit.

billing_cycle_interval_unit

The unit in which the billing 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.

Properties

The plan associated to this subscription.

address

Primary or shipping address line.

Array of assets assigned to the subscription.

bill_to_address

Billing address line.

bill_to_city

Billing address city.

bill_to_company_name

Billing address Company name of the customer.

bill_to_country

Billing address country. Two-letter country code.

bill_to_full_address

Billing address field where address line and house number are combined.

bill_to_full_name

Billing address Full name of the customer. First name and last name merged into a single attribute.

bill_to_house_number

Billing address house number.

bill_to_last_name

Billing address Last name of the customer.

bill_to_name

Billing address First name of the customer.

bill_to_phone_number

Billing address phone number.

bill_to_salutation

Billing address Salutation of the customer. Sometimes used as gender. Possible values: mr, ms, mx.

bill_to_state

Billing address state.

bill_to_zipcode

Billing address zipcode or postal code.

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_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.

company_name

Company name of the customer.

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_symbol

The currency symbol the subscription is billed in. Example: € or $.

Array of customer feedbacks for this subscription.

customer_id

The customer ID of the subscription.

customer_reference

Your reference field for this subscription.

email

The email address of the subscription.

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

The ID of the subscription.

imported_subscription_id

Your reference field back to an ID from a system where this subscription was imported from.

initial_or_recurring_invoices_count

The number of initial and recurring invoices that were invoiced so far for this subscription.

Array of invoices of the subscription.

last_name

Last name of the customer.

last_order_id

The ID of the most recently created order for this subscription.

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.

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 that was last calculated for the subscription, in cents. Example: 1210

name

First name of the customer.

next_billing_date

The upcoming date the customer will be billed on. Only on plan-based projects.

Array of ordered_product objects that are scheduled to ship next.

not_purchased_asset_ownership_ids

An array of asset_ownership IDs that are not yet purchased.

Array of ordered_product objects that are on this subscription.

payment_method

The payment method currently active on the subscription.

phone_number

Primary or shipping address phone number.

Array of products on the subscription.

salutation

Salutation of the customer. Sometimes used as gender. Possible values: mr, ms, mx.

signup_completed_at

The date and time the subscription completed their signup and initial payment.

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.

How the subscription is subscribed to its current plan.

subscription_started_at

The date and time the subscription was activated and started.

token

The token of the subscription.

track_and_trace_code

The tracking code stored on the subscription.

update_payment_method_url

URL where the customer can update their payment method.

zipcode

Primary or shipping address zipcode or postal code.

Last updated