{'type': 'object', 'title': 'Orders', 'description': 'Orders', 'required': ['id', 'workspace_id', 'contact_id', 'currency', 'origination_channel_id', 'contact', 'workspace'], 'properties': {'id': {'type': 'integer', 'description': 'ClickFunnels Order ID'}, 'public_id': {'type': ['string', 'null'], 'description': 'ClickFunnels Order public ID'}, 'order_number': {'type': ['string', 'null'], 'description': 'A sequential number for bookkeeping purposes increased by 1 for each new order in a workspace starting from \\#1001.'}, 'workspace_id': {'type': 'integer', 'description': 'ClickFunnels Workspace ID'}, 'contact_id': {'type': 'integer', 'description': 'The contact associated with the order.'}, 'live_mode': {'type': ['boolean', 'null'], 'description': 'Indicates if the Order will use a live payment gateway and process real credit cards, or if it will use a test gateway and only process test cards.\n'}, 'total_amount': {'type': ['string', 'null'], 'description': "The total amount of the order, considering taxes and discounts. For external orders, it's the sum of all line items' price amounts times their quantities."}, 'currency': {'type': 'string', 'description': 'Currency'}, 'origination_channel_id': {'type': 'integer', 'description': 'Origination Channel ID'}, 'origination_channel_type': {'type': ['string', 'null'], 'description': 'Origination Channel Type'}, 'shipping_address_first_name': {'type': ['string', 'null'], 'description': "The first name of the recipient's shipping address.\n"}, 'shipping_address_last_name': {'type': ['string', 'null'], 'description': "The last name of the recipient's shipping address.\n"}, 'shipping_address_organization_name': {'type': ['string', 'null'], 'description': "The organization name of the recipient's shipping address.\n"}, 'shipping_address_phone_number': {'type': ['string', 'null'], 'description': "The phone number of the recipient's shipping address.\n"}, 'shipping_address_street_one': {'type': ['string', 'null'], 'description': 'The main street information of the shipping address, including the street name and number.'}, 'shipping_address_street_two': {'type': ['string', 'null'], 'description': 'Additional street information for the shipping address, like entrance information and apartment numbers.'}, 'shipping_address_city': {'type': ['string', 'null'], 'description': 'The city of the shipping address.'}, 'shipping_address_region': {'type': ['string', 'null'], 'description': 'The region of the shipping address, like state or province.'}, 'shipping_address_country': {'type': ['string', 'null'], 'description': 'The country of the shipping address.\n'}, 'shipping_address_postal_code': {'type': ['string', 'null'], 'description': 'Postal Code'}, 'billing_address_street_one': {'type': ['string', 'null'], 'description': 'The main street information of the billing address, including the street name and number.\n'}, 'billing_address_street_two': {'type': ['string', 'null'], 'description': 'Additional street information of the billing address, like entrance information and apartment numbers.\n'}, 'billing_address_city': {'type': ['string', 'null'], 'description': 'The city of the billing address.\n'}, 'billing_address_region': {'type': ['string', 'null'], 'description': 'The region of the shipping address, like state or province.\n'}, 'billing_address_country': {'type': ['string', 'null'], 'description': 'The billing address country.\n'}, 'billing_address_postal_code': {'type': ['string', 'null'], 'description': 'Billing address postal (ZIP) code.\n'}, 'page_id': {'type': ['integer', 'null'], 'description': 'Page ID'}, 'notes': {'type': ['string', 'null'], 'description': 'Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections.'}, 'in_trial': {'type': ['boolean', 'null'], 'description': 'In Trial'}, 'billing_status': {'type': ['string', 'null'], 'description': 'The billing status reflects the status of the invoice of an order.\nBilling status can be one of the following for Payments AI and Stripe orders:\n`pending`, `draft`, `paid`, `unpaid`, `partially-refunded`, `refunded`, `voided`, `disputed`, `past-due`.\n\nFor external orders, the billing status can be one of: `pending`, `paid`, `unpaid`, `voided` and `refunded`.\n'}, 'service_status': {'type': ['string', 'null'], 'description': 'The service status reflects the activity state of the order. For subscriptions, it can control whether a subscription is ongoing, for example despite an irregular (unpaid) invoice status.\n\nFor orders with Payments AI as the payment processor, it can be one of the following:\n`pending`, `active`, `completed`, `churned`, `canceled`, `suspended`, `paused`, `abandoned`, `voided`\nStripe orders have the same order statuses, except for `voided`. For voided invoices, its service status becomes `abandoned`.\nYou can read about the state transitions in more detail in our [orders overview guide](https://developers.myclickfunnels.com/docs/orders).\n\nFor external one-time orders possible service statuses are `pending` or `completed`. For external subscription orders possible statuses are `pending`, `active`, `churned`, `canceled`, `completed`, `paused`.\n'}, 'order_type': {'type': ['string', 'null'], 'description': 'Order Type'}, 'next_charge_at': {'type': ['string', 'null'], 'description': 'Next Charge At'}, 'tax_amount': {'type': ['string', 'null'], 'description': 'Tax Amount'}, 'trial_end_at': {'type': ['string', 'null'], 'description': 'Trial End At'}, 'billing_payment_method_id': {'type': ['string', 'null'], 'description': 'Payment Method'}, 'funnel_name': {'type': ['string', 'null'], 'description': 'Funnel Name'}, 'tag_ids': {'type': ['array', 'null'], 'minContains': 0, 'contains': {'type': 'integer'}, 'description': 'Order Tags'}, 'discount_ids': {'type': ['array', 'null'], 'description': 'Discounts'}, 'activated_at': {'type': ['string', 'null'], 'description': 'Date Activated'}, 'workspace_sharing_id': {'type': ['string', 'null'], 'description': 'Workspace Sharing ID'}, 'canceled_at': {'type': ['string', 'null'], 'description': 'Order Canceled At'}, 'canceled_by': {'type': ['string', 'null'], 'description': 'Order Canceled By'}, 'cancel_reason': {'type': ['string', 'null'], 'description': 'The reason _code_ for the cancelation, it is required when canceling an order.\n\nPossible codes for Payments AI orders are:\n`did-not-use`, `did-not-want`, `missing-features`, `too-expensive`, `bugs-or-problems`, `other`\n\nPossible codes for Stripe orders are:\n`customer_service`, `low_quality`, `missing_features`, `other`, `switched_service`, `too_complex`, `too_expensive`, `unused`\n\nExternal orders accept the same cancelation reasons as Stripe.\n'}, 'cancel_description': {'type': ['string', 'null'], 'description': 'A free-text description of the cancellation reason.'}, 'churned_at': {'type': ['string', 'null'], 'description': 'Churned At'}, 'created_at': {'type': ['string', 'null'], 'format': 'date-time', 'description': 'Date Ordered'}, 'updated_at': {'type': ['string', 'null'], 'format': 'date-time', 'description': 'Date Updated'}, 'external_id': {'type': ['string', 'null'], 'description': "An external ID, e.g., a payment provider's ID or an ID managed by the client internally"}, 'payment_processor': {'type': ['string', 'null'], 'description': 'The payment processor of the order. Currently, it can be one of `payments_ai` and `external`.'}, 'phone_number': {'type': ['string', 'null'], 'description': 'Phone Number'}, 'page_name': {'type': ['string', 'null'], 'description': 'Page Name. Want to filter by it? See our help guide on that topic.'}, 'origination_channel_name': {'type': ['string', 'null'], 'description': 'Origination Channel Name'}, 'order_page': {'type': ['object', 'null'], 'title': 'Page', 'description': 'Page', 'required': ['id', 'name'], 'properties': {'id': {'type': 'integer', 'description': 'Page ID'}, 'public_id': {'type': ['string', 'null'], 'description': 'Page Public ID'}, 'name': {'type': 'string', 'description': 'Page name of the editable page element. Want to filter by it? See our help guide on that topic.'}}}, 'contact': {'type': 'object', 'allOf': [{'$ref': '#/components/schemas/ContactAttributes'}], 'description': 'Customer'}, 'contact_groups': {'type': ['array', 'null'], 'items': {'type': 'object', 'title': 'Groups', 'description': 'Groups', 'required': ['id', 'name'], 'properties': {'id': {'type': 'integer', 'description': 'Group ID'}, 'public_id': {'type': ['string', 'null'], 'description': 'Group Public ID'}, 'name': {'type': 'string', 'description': 'Name'}}}, 'description': 'Contact Groups'}, 'workspace': {'type': 'object', 'allOf': [{'$ref': '#/components/schemas/WorkspaceAttributes'}], 'description': 'Workspace'}, 'segments': {'type': ['array', 'null'], 'items': {'type': 'object', 'title': 'Segments', 'description': 'Segments', 'required': ['id', 'name'], 'properties': {'id': {'type': 'integer', 'description': 'Segment ID'}, 'public_id': {'type': ['string', 'null'], 'description': 'Segment public ID'}, 'name': {'type': 'string', 'description': 'Name'}}}, 'description': 'Segments'}, 'line_items': {'type': ['array', 'null'], 'items': {'$ref': '#/components/schemas/OrdersLineItemAttributes'}, 'description': 'Order Line Items'}, 'previous_line_item': {'type': ['string', 'null'], 'description': 'An additional field, only available in outgoing subscription.upgrade/subscription.downgrade webhooks. It enables you to identify the former line item which is otherwise removed from the regular subscription line items when an upgrade or downgrade happens. Thus you can see the data of the previously active subscription. This property will not appear in regular API requests, but only in the event of a subscription upgrade or downgrade.'}, 'affiliate': {'type': ['object', 'null'], 'title': 'Affiliate', 'description': 'The affiliate who will receive a commission for the order', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'The name of the affiliate. Can be a combination of first name, last name and the affiliate email.'}, 'email': {'type': ['string', 'null'], 'description': 'The email address of the affiliate.'}}}, 'referral_code': {'type': ['object', 'null'], 'title': 'Referral Code', 'description': 'The referral code used to associate an order with an affiliate.', 'required': ['code'], 'properties': {'code': {'type': 'string', 'description': 'The referral code value visible by users. It must be unique and can contain only letters, numbers, hyphens, and underscores.'}, 'default': {'type': ['boolean', 'null'], 'description': 'Whether this code is the default code for the affiliate.'}}}}, 'example': {'id': 2, 'public_id': 'usxWaX', 'order_number': '425730', 'workspace_id': 42000, 'contact_id': 9, 'live_mode': True, 'total_amount': '123.00', 'currency': 'USD', 'origination_channel_id': 3, 'origination_channel_type': 'User', 'shipping_address_first_name': 'Lenita', 'shipping_address_last_name': 'Runte', 'shipping_address_organization_name': 'Testing, Inc.', 'shipping_address_phone_number': '+19053871234', 'shipping_address_street_one': '807 Jacobs Well', 'shipping_address_street_two': 'Apt. 986', 'shipping_address_city': 'North Gaye', 'shipping_address_region': 'WA', 'shipping_address_country': 'US', 'shipping_address_postal_code': '16200-7595', 'billing_address_street_one': '247 Herminia Neck', 'billing_address_street_two': 'Suite 169', 'billing_address_city': 'South Whitneyton', 'billing_address_region': 'WA', 'billing_address_country': 'US', 'billing_address_postal_code': '61159-2857', 'page_id': 3, 'notes': 'Numquam ea illum harum.', 'in_trial': False, 'billing_status': 'pending', 'service_status': 'pending', 'order_type': 'one-time-order', 'next_charge_at': None, 'tax_amount': '0.00', 'trial_end_at': None, 'billing_payment_method_id': None, 'funnel_name': None, 'tag_ids': [2], 'discount_ids': [], 'activated_at': None, 'workspace_sharing_id': None, 'canceled_at': None, 'canceled_by': None, 'cancel_reason': None, 'cancel_description': None, 'churned_at': None, 'created_at': '2025-04-21T14:47:46.914Z', 'updated_at': '2025-04-21T14:47:46.914Z', 'external_id': None, 'payment_processor': 'payments_ai', 'phone_number': '1-292-348-1125 x8995', 'page_name': 'Great Page', 'origination_channel_name': '', 'order_page': {'id': 3, 'public_id': 'CoFGTR', 'name': 'Great Page'}, 'contact': {'id': 9, 'public_id': 'wtTjOp', 'workspace_id': 42000, 'anonymous': None, 'email_address': 'test-abb0437740cf4e1b3a02@example.com', 'first_name': 'Lorretta', 'last_name': 'Haag', 'phone_number': '1-292-348-1125 x8995', 'time_zone': 'Pacific Time (US & Canada)', 'uuid': '45bbe6cc-7958-4b82-a9e4-7a50f2278498', 'unsubscribed_at': None, 'last_notification_email_sent_at': None, 'fb_url': 'https://www.facebook.com/example', 'twitter_url': 'https://twitter.com/example', 'instagram_url': None, 'linkedin_url': 'https://www.linkedin.com/in/example', 'website_url': 'https://example.com', 'created_at': '2025-04-21T14:47:46.741Z', 'updated_at': '2025-04-21T14:47:46.741Z', 'tags': [{'id': 11, 'public_id': 'JmHyKR', 'name': 'Example Tag', 'color': '#31fb66', 'applied_at': None}], 'custom_attributes': {'CustomKey': 'MyText'}}, 'contact_groups': [{'id': 2, 'public_id': 'Wxkrtd', 'name': 'Example Group'}], 'workspace': {'id': 42000, 'public_id': 'kVwLOn', 'team_id': 42000, 'name': 'Example Workspace', 'subdomain': 'example', 'created_at': '2025-04-21T14:47:46.733Z', 'updated_at': '2025-04-21T14:47:46.733Z'}, 'segments': [{'id': 2, 'public_id': 'pxkJRo', 'name': 'Example Segment'}], 'line_items': [{'id': 2, 'public_id': 'OJMAJB', 'order_id': 2, 'quantity': 1, 'prorated': None, 'created_at': '2024-12-07T20:24:53.324Z', 'updated_at': '2025-01-27T12:50:45.156Z', 'original_product': {'id': 6503, 'public_id': 'Ykznlj', 'name': 'Cool Shirt'}, 'products_price': {'id': 44, 'public_id': 'eJxGaN', 'amount': '29.00', 'currency': 'usd', 'duration': None, 'interval': None, 'interval_count': None, 'key': None}, 'products_variant': {'id': 11, 'public_id': 'OjzDND', 'name': 'Cool Shirt', 'description': '', 'sku': 'sku_2611840167'}}, {'id': 2, 'public_id': 'WOguUf', 'order_id': 2, 'quantity': 1, 'prorated': None, 'created_at': None, 'updated_at': None, 'original_product': {'id': 5, 'public_id': 'vlnosr', 'name': 'Lightweight Linen Shoes 27295c'}, 'products_price': {'id': 4, 'public_id': 'cOudHU', 'amount': '100.00', 'currency': 'USD', 'duration': None, 'interval': None, 'interval_count': None, 'key': None}, 'products_variant': {'id': 4, 'public_id': 'gIkSVA', 'name': 'Ergonomic Cotton Shoes variant bea1', 'description': 'Aut et et tempore.', 'sku': 'G8EpjWT2x1bofGnf'}}], 'previous_line_item': None, 'affiliate': {'name': 'Josh Fancy', 'email': 'test-b81cc8ac8c18a2138874@example.com'}, 'referral_code': {'code': 'd473754c5567e94800c1d16ef4b3fb394b9cfe49f25c80f755226186c390740c', 'default': True}}} is not valid under any of the given schemas