# Schema Information

## Tables/APIs 

The following is the list of tables or APIs associated with the Upscribe v2 connector:

* [collections](#collections) 
* [customers](#customers) 
* [orders](#orders) 
* [refunds](#refunds) 
* [products](#products) 
* [subscription](#subscription) 
* [subscription\_history\_report](#subscription_history_report)

## Upscribe Data

#### **collections** 

Purpose: Returns the collections information associated with the Upscribe account and your domain.

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>body_html</td><td>STRING</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>handle</td><td>STRING</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>sort_order</td><td>STRING</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>title</td><td>STRING</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr></tbody></table>

#### **customers**&#x20;

Purpose: Gets all the customer information and cards associated with the upscribe account and your domain.

Source API Documentation: [Upscribe V2- Customers API](https://api.upscribe.io/#5d3fb090-8e73-41b6-a3a4-dedf2e62defe)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>accepts_marketing</td><td>BOOLEAN</td></tr><tr><td>active_subscription_count</td><td>NUMERIC</td></tr><tr><td>addresses</td><td>RECORD</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>customer_tags</td><td>STRING</td></tr><tr><td>default_address</td><td>RECORD</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>email_marketing_consent</td><td>RECORD</td></tr><tr><td>first_name</td><td>STRING</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>inactive_subscription_count</td><td>NUMERIC</td></tr><tr><td>language</td><td>STRING</td></tr><tr><td>last_name</td><td>STRING</td></tr><tr><td>state</td><td>STRING</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>tax_exempt</td><td>BOOLEAN</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr></tbody></table>

#### **orders**&#x20;

Purpose: Returns the list of order information associated with the Upscribe account and your given domain.

Source API Documentation: [Upscribe V2- Orders API](https://api.upscribe.io/#84cf528d-0630-4ffd-bf2e-291f02be8a5e)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>billing_address</td><td>RECORD</td></tr><tr><td>buyer_accepts_marketing</td><td>BOOLEAN</td></tr><tr><td>contact_email</td><td>STRING</td></tr><tr><td>create_subscription</td><td>BOOLEAN</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>customer</td><td>RECORD</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>financial_status</td><td>STRING</td></tr><tr><td>guest_checkout</td><td>BOOLEAN</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>line_items</td><td>RECORD</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>number</td><td>NUMERIC</td></tr><tr><td>order_number</td><td>NUMERIC</td></tr><tr><td>payment_charge_id</td><td>STRING</td></tr><tr><td>payment_customer_id</td><td>NUMERIC</td></tr><tr><td>payment_method</td><td>RECORD</td></tr><tr><td>payment_method_id</td><td>STRING</td></tr><tr><td>payment_type</td><td>STRING</td></tr><tr><td>presentment_currency</td><td>STRING</td></tr><tr><td>processed_at</td><td>DATETIME</td></tr><tr><td>shipping_address</td><td>RECORD</td></tr><tr><td>shipping_lines</td><td>RECORD</td></tr><tr><td>shopify_customer_id</td><td>NUMERIC</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>subscription_in_progress</td><td>BOOLEAN</td></tr><tr><td>subtotal_price</td><td>NUMERIC</td></tr><tr><td>tags</td><td>STRING</td></tr><tr><td>taxes_included</td><td>BOOLEAN</td></tr><tr><td>token</td><td>STRING</td></tr><tr><td>total_discounts</td><td>NUMERIC</td></tr><tr><td>total_line_items_price</td><td>NUMERIC</td></tr><tr><td>total_price</td><td>NUMERIC</td></tr><tr><td>total_shipping_price_set</td><td>RECORD</td></tr><tr><td>total_tax</td><td>NUMERIC</td></tr><tr><td>tracking_codes</td><td>RECORD</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr></tbody></table>

#### **refunds**&#x20;

Purpose: Returns all the refunds associated with the upscribe account and your domain.

Source API Documentation: [Upscribe V2- Refunds API](https://api.upscribe.io/#1454a61b-54eb-4586-9d7f-5113acfd7293)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>amount</td><td>NUMERIC</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>currency</td><td>STRING</td></tr><tr><td>id</td><td>STRING</td></tr><tr><td>payment_charge_id</td><td>STRING</td></tr><tr><td>shopify_order_id</td><td>NUMERIC</td></tr><tr><td>status</td><td>STRING</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr></tbody></table>

#### **products**&#x20;

Purpose: Returns all the List of product information associated with the upscribe account and your given domain.

Source API Documentation: [Upscribe V2- Products API](https://api.upscribe.io/#b20acb5e-7d02-4f26-90e4-2ff65394e6b6)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>body_html</td><td>STRING</td></tr><tr><td>collections</td><td>RECORD</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>handle</td><td>STRING</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>image</td><td>RECORD</td></tr><tr><td>images</td><td>RECORD</td></tr><tr><td>in_sales_channel</td><td>BOOLEAN</td></tr><tr><td>is_subscription</td><td>BOOLEAN</td></tr><tr><td>metafields</td><td>RECORD</td></tr><tr><td>options</td><td>RECORD</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>template_suffix</td><td>STRING</td></tr><tr><td>title</td><td>STRING</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr><tr><td>variants</td><td>RECORD</td></tr><tr><td>vendor</td><td>STRING</td></tr></tbody></table>

#### **subscription**&#x20;

Purpose: Returns all the subscriptions associated with the upscribe account and your domain.

Source API Documentation: [Upscribe V2- Subscription API](https://api.upscribe.io/#e6bc9557-54d3-4833-8dfa-167160552782)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>active</td><td>BOOLEAN</td></tr><tr><td>billing_address</td><td>RECORD</td></tr><tr><td>cancellation_comment</td><td>STRING</td></tr><tr><td>cancellation_reminder_sent</td><td>BOOLEAN</td></tr><tr><td>cancelled_on</td><td>DATETIME</td></tr><tr><td>charge_limit</td><td>NUMERIC</td></tr><tr><td>coupon_discount</td><td>NUMERIC</td></tr><tr><td>coupon_discount_title</td><td>STRING</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>interval</td><td>NUMERIC</td></tr><tr><td>items</td><td>RECORD</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>needs_recalculate</td><td>BOOLEAN</td></tr><tr><td>order_count</td><td>NUMERIC</td></tr><tr><td>order_ids</td><td>STRING</td></tr><tr><td>payment_customer_id</td><td>STRING</td></tr><tr><td>payment_method_id</td><td>STRING</td></tr><tr><td>payment_type</td><td>STRING</td></tr><tr><td>period</td><td>STRING</td></tr><tr><td>product_linked_discount</td><td>NUMERIC</td></tr><tr><td>requires_customer_update</td><td>BOOLEAN</td></tr><tr><td>requires_update</td><td>BOOLEAN</td></tr><tr><td>shipping_address</td><td>RECORD</td></tr><tr><td>shipping_lines</td><td>RECORD</td></tr><tr><td>shopify_customer_email</td><td>STRING</td></tr><tr><td>shopify_customer_id</td><td>NUMERIC</td></tr><tr><td>shopify_order_id</td><td>NUMERIC</td></tr><tr><td>store_id</td><td>NUMERIC</td></tr><tr><td>taxes_included</td><td>BOOLEAN</td></tr><tr><td>total_line_items_price</td><td>NUMERIC</td></tr><tr><td>total_price</td><td>NUMERIC</td></tr><tr><td>total_tax</td><td>NUMERIC</td></tr><tr><td>tracking_codes</td><td>RECORD</td></tr><tr><td>updated_at</td><td>DATETIME</td></tr></tbody></table>

#### **subscription\_history\_report**

Purpose: Returns all the history reports of subscriptions associated with the upscribe account and your domain.

Source API Documentation: [Upscribe V2- Subscription Report API](https://api.upscribe.io/#3c106b6c-230e-4cc7-8429-76925ade7fcc)

**FIELDS**

<table><thead><tr><th width="78">Field Name</th><th width="78">Data Type</th></tr></thead><tbody><tr><td>admin_email</td><td>STRING</td></tr><tr><td>admin_id</td><td>STRING</td></tr><tr><td>created_at</td><td>DATETIME</td></tr><tr><td>id</td><td>STRING</td></tr><tr><td>is_admin</td><td>STRING</td></tr><tr><td>item_id</td><td>STRING</td></tr><tr><td>new_value</td><td>STRING</td></tr><tr><td>old_value</td><td>STRING</td></tr><tr><td>product_title</td><td>STRING</td></tr><tr><td>queue_id</td><td>STRING</td></tr><tr><td>requested_by_ip</td><td>STRING</td></tr><tr><td>subscription_id</td><td>STRING</td></tr><tr><td>variant_title</td><td>STRING</td></tr><tr><td>shopify_customer_email</td><td>STRING</td></tr><tr><td>description</td><td>STRING</td></tr><tr><td>shopify_customer_id</td><td>STRING</td></tr><tr><td>reason</td><td>STRING</td></tr></tbody></table>