shopify-webhook-schemas 0.2.9 → 0.3.2

package/metadatas/2026-01/shop/update.json

@@ -0,0 +1,70 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a shop is updated.",
+  "name": "shop/update",
+  "related_resource": "Shop",
+  "response": {
+    "id": 548380009,
+    "name": "Super Toys",
+    "email": "super@supertoys.com",
+    "domain": null,
+    "province": "Tennessee",
+    "country": "US",
+    "address1": "190 MacLaren Street",
+    "zip": "37178",
+    "city": "Houston",
+    "source": null,
+    "phone": "3213213210",
+    "latitude": null,
+    "longitude": null,
+    "primary_locale": "en",
+    "address2": null,
+    "created_at": null,
+    "updated_at": null,
+    "country_code": "US",
+    "country_name": "United States",
+    "currency": "USD",
+    "customer_email": "super@supertoys.com",
+    "timezone": "(GMT-05:00) Eastern Time (US & Canada)",
+    "iana_timezone": null,
+    "shop_owner": "John Smith",
+    "money_format": "${{amount}}",
+    "money_with_currency_format": "${{amount}} USD",
+    "weight_unit": "kg",
+    "province_code": "TN",
+    "taxes_included": null,
+    "auto_configure_tax_inclusivity": null,
+    "tax_shipping": null,
+    "county_taxes": null,
+    "plan_display_name": "Shopify Plus",
+    "plan_name": "enterprise",
+    "has_discounts": false,
+    "has_gift_cards": true,
+    "myshopify_domain": null,
+    "google_apps_domain": null,
+    "google_apps_login_enabled": null,
+    "money_in_emails_format": "${{amount}}",
+    "money_with_currency_in_emails_format": "${{amount}} USD",
+    "eligible_for_payments": true,
+    "requires_extra_payments_agreement": false,
+    "password_enabled": null,
+    "has_storefront": true,
+    "finances": true,
+    "primary_location_id": 655441491,
+    "checkout_api_supported": true,
+    "multi_location_enabled": true,
+    "setup_required": false,
+    "pre_launch_enabled": false,
+    "enabled_presentment_currencies": [
+      "USD"
+    ],
+    "marketing_sms_consent_enabled_at_checkout": false,
+    "transactional_sms_disabled": false
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_attempts/challenged.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when the financial instutition challenges the subscripttion billing attempt charge as per 3D Secure.",
+  "name": "subscription_billing_attempts/challenged",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "SubscriptionBillingAttempt",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_attempts/failure.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription billing attempt fails.",
+  "name": "subscription_billing_attempts/failure",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "SubscriptionBillingAttempt",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_attempts/success.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription billing attempt succeeds.",
+  "name": "subscription_billing_attempts/success",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "SubscriptionBillingAttempt",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_cycle_edits/create.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract billing cycle is edited.",
+  "name": "subscription_billing_cycle_edits/create",
+  "related_resource": "SubscriptionBillingCycle",
+  "response": {
+    "subscription_contract_id": 7742531746,
+    "cycle_start_at": "2022-10-01T00:00:00-04:00",
+    "cycle_end_at": "2022-11-01T00:00:00-04:00",
+    "cycle_index": 1,
+    "contract_edit": null,
+    "billing_attempt_expected_date": "2022-11-01T00:00:00-04:00",
+    "skipped": false,
+    "edited": false
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_cycle_edits/delete.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract billing cycle edit is deleted.",
+  "name": "subscription_billing_cycle_edits/delete",
+  "related_resource": "SubscriptionBillingCycle",
+  "response": {
+    "subscription_contract_id": 5968910912,
+    "cycle_start_at": "2022-10-01T00:00:00-04:00",
+    "cycle_end_at": "2022-11-01T00:00:00-04:00",
+    "cycle_index": 1,
+    "contract_edit": null,
+    "billing_attempt_expected_date": "2022-11-01T00:00:00-04:00",
+    "skipped": false,
+    "edited": false
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_cycle_edits/update.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract billing cycle edit is updated.",
+  "name": "subscription_billing_cycle_edits/update",
+  "related_resource": "SubscriptionBillingCycle",
+  "response": {
+    "subscription_contract_id": 4196007463,
+    "cycle_start_at": "2022-10-01T00:00:00-04:00",
+    "cycle_end_at": "2022-11-01T00:00:00-04:00",
+    "cycle_index": 1,
+    "contract_edit": null,
+    "billing_attempt_expected_date": "2022-11-01T00:00:00-04:00",
+    "skipped": false,
+    "edited": false
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_cycles/skip.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract billing cycle is skipped.",
+  "name": "subscription_billing_cycles/skip",
+  "related_resource": "SubscriptionBillingCycle",
+  "response": {
+    "subscription_contract_id": 4093871313,
+    "cycle_start_at": "2022-10-01T00:00:00-04:00",
+    "cycle_end_at": "2022-11-01T00:00:00-04:00",
+    "cycle_index": 1,
+    "contract_edit": null,
+    "billing_attempt_expected_date": "2022-11-01T00:00:00-04:00",
+    "skipped": true,
+    "edited": true
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_billing_cycles/unskip.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract billing cycle is unskipped.",
+  "name": "subscription_billing_cycles/unskip",
+  "related_resource": "SubscriptionBillingCycle",
+  "response": {
+    "subscription_contract_id": 1863732535,
+    "cycle_start_at": "2022-10-01T00:00:00-04:00",
+    "cycle_end_at": "2022-11-01T00:00:00-04:00",
+    "cycle_index": 1,
+    "contract_edit": null,
+    "billing_attempt_expected_date": "2022-11-01T00:00:00-04:00",
+    "skipped": false,
+    "edited": true
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/activate.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a subscription contract is activated.",
+  "name": "subscription_contracts/activate",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/633027224",
+    "id": 633027224,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "active",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "5553572751"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/cancel.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a subscription contract is canceled.",
+  "name": "subscription_contracts/cancel",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/5438662217",
+    "id": 5438662217,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "cancelled",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "3726446126"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/create.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract is created.",
+  "name": "subscription_contracts/create",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/186296837",
+    "id": 186296837,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "active",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "8266632426"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/expire.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a subscription contract expires.",
+  "name": "subscription_contracts/expire",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/3962119559",
+    "id": 3962119559,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "expired",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "4110181866"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/fail.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a subscription contract is failed.",
+  "name": "subscription_contracts/fail",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/5068780399",
+    "id": 5068780399,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "failed",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "317849357"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/pause.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a subscription contract is paused.",
+  "name": "subscription_contracts/pause",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/4825426790",
+    "id": 4825426790,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "paused",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "2138415401"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/subscription_contracts/update.json

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "own_subscription_contracts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a subscription contract is updated.",
+  "name": "subscription_contracts/update",
+  "related_resource": "SubscriptionContract",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SubscriptionContract/8859986047",
+    "id": 8859986047,
+    "billing_policy": {
+      "interval": "week",
+      "interval_count": 4,
+      "min_cycles": 1,
+      "max_cycles": 2
+    },
+    "currency_code": "CAD",
+    "customer_id": 1,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/1",
+    "delivery_policy": {
+      "interval": "week",
+      "interval_count": 2
+    },
+    "status": "active",
+    "admin_graphql_api_origin_order_id": "gid://shopify/Order/1",
+    "origin_order_id": 1,
+    "revision_id": "5359684060"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/tax_services/create.json

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "taxes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a tax service is created.",
+  "name": "tax_services/create",
+  "related_resource": "TaxService",
+  "response": {
+    "id": null,
+    "name": "Tax Service",
+    "url": "https://taxes.shopify.com",
+    "active": true
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/tax_services/update.json

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "taxes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenver a tax service is updated.",
+  "name": "tax_services/update",
+  "related_resource": "TaxService",
+  "response": {
+    "id": null,
+    "name": "Tax Service",
+    "url": "https://taxes.shopify.com",
+    "active": true
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/tender_transactions/create.json

@@ -0,0 +1,30 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a tender transaction is created.",
+  "name": "tender_transactions/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "TenderTransaction",
+  "response": {
+    "id": 220982911946154500,
+    "order_id": 820982911946154500,
+    "amount": "419.95",
+    "currency": "USD",
+    "user_id": null,
+    "test": false,
+    "processed_at": null,
+    "remote_reference": "1001",
+    "payment_details": null,
+    "payment_method": "unknown"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/themes/create.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "themes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a theme is created. Does not occur when theme files are created.",
+  "name": "themes/create",
+  "related_resource": "Theme",
+  "response": {
+    "id": 512162865275216960,
+    "name": "Comfort",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "role": "main",
+    "theme_store_id": 1234,
+    "previewable": true,
+    "processing": false,
+    "admin_graphql_api_id": "gid://shopify/Theme/512162865275216980"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/themes/delete.json

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "themes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a theme is deleted. Does not occur when theme files are deleted.",
+  "name": "themes/delete",
+  "related_resource": "Theme",
+  "response": {
+    "id": 512162865275216960
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/themes/publish.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "themes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a theme with the main or mobile (deprecated) role is published.",
+  "name": "themes/publish",
+  "related_resource": "Theme",
+  "response": {
+    "id": 512162865275216960,
+    "name": "Comfort",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "role": "main",
+    "theme_store_id": 1234,
+    "previewable": true,
+    "processing": false,
+    "admin_graphql_api_id": "gid://shopify/Theme/512162865275216980"
+  },
+  "shop_feature": false
+}