# 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. |
| product ([product](#product)) | 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. |
| invoice\_line\_items ([\[invoice\_line\_item\]](#invoice_line_item)) | 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. |
| original\_invoice ([invoice](#invoice)) | 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. |
| 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](#payment)) | 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 | |
| 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.
| Properties | |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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](#product)) | 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\_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
| 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. |
| order\_lines ([\[order\_line\]](#order_line)) | 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 ([\[product\]](#product)) | Products on this order based via its order lines. |
| 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\_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.
|
| 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 | |
| ------------------------------------ | -------------------------------------------------------- |
| 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 |
| locale | |
| metadata | Metadata on the order line line item in key-value pairs. |
| product ([product](#product)) | The product associated with this order line. |
| product\_sku | The product SKU. |
| product\_title | The product title. |
| product\_type | The product type. |
| quantity | The quantity of the order line. |
| 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 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.
|
| 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
|
| plan ([plan](#plan)) | The plan this ordered\_product is part of. |
| price | The price of the ordered product formatted with currency symbol. |
| price\_cents | The price of the ordered product in cents. |
| product ([product](#product)) | 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. |
| shopify\_subscription\_line\_id | The Shopify subscription line ID associated with this ordered product (only for native subscriptions). |
| 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\_attempt? | |
| retry\_payment\_url | |
| scheduled\_retry\_on | |
| shopify\_subscription\_billing\_attempt\_id | The Shopify subscription billing attempt ID associated with this payment (only for native subscriptions). |
| 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 | |
| localized\_public\_name | |
| localized\_title | |
| 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\_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. |
| 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.
| Properties | |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active\_plan ([plan](#plan)) | The plan associated to this 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\]](#applied_promotion)) | Array of applied promotions for this subscription. |
| assets ([\[asset\]](#asset)) | Array of assets assigned to the subscription. |
| 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\_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\]](#collection_case)) | Array of collection cases for this subscription. |
| 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 $. |
| customer\_feedbacks ([\[customer\_feedback\]](#customer_feedback)) | Array of customer feedbacks for this subscription. |
| customer\_id | The customer ID of the subscription. |
| 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.). |
| email | The email address of the subscription. |
| extra\_fields | Array of extra fields for this subscription. |
| extra\_fields\_v2 ([\[extra\_field\_answer\]](#extra_field_answer)) | Array of extra field answers for this 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\_invoice ([\[invoice\]](#invoice)) | The initial invoice for this subscription. |
| initial\_or\_recurring\_invoices\_count | The number of initial and recurring invoices that were invoiced so far for this subscription. |
| invoices ([\[invoice\]](#invoice)) | 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. |
| latest\_five\_orders ([\[order\]](#order)) | Array of the 5 most recent orders 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. |
| 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 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. |
| next\_order\_preview ([order](#order)) | Preview of the next order that is expected for this subscription. |
| next\_upcoming\_products ([\[ordered\_product\]](#ordered_product)) | 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. |
| ordered\_products ([\[ordered\_products\]](#ordered_products)) | Array of ordered\_product objects that are on this subscription. |
| outstanding\_amount | The total outstanding amount for this subscription. |
| pause\_subscription\_url | URL where the subscription can be paused. |
| payment\_method | The payment method currently active on the subscription. |
| payment\_method\_summary | The payment method currently active on the subscription. |
| phone\_number | Primary or shipping address phone number. |
| pickup\_point ([\[pickup\_point\]](#pickup_point)) | The pickup point associated with this subscription |
| products ([\[product\]](#product)) | Array of products on the subscription. |
| referral\_code | The referral code for this subscription. |
| resume\_subscription\_url | URL where the subscription can be resumed. |
| salutation | Salutation of the customer. Sometimes used as gender. Possible values: mr, ms, mx. |
| 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. |
| 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.
|
| subscribed\_plan ([subscribed\_plan](#subscribed_plan)) | How the subscription is subscribed to its current plan. |
| subscription\_acceptance\_checks ([\[subscription\_acceptance\_check\]](#subscription_acceptance_check)) | Array of subscription acceptance checks for this subscription. |
| 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 | 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. |
| 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. |