shopify-webhook-schemas 0.2.9 → 0.3.2

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

@@ -0,0 +1,283 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "address1": {
+      "type": "string"
+    },
+    "address2": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "auto_configure_tax_inclusivity": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "checkout_api_supported": {
+      "type": "boolean"
+    },
+    "city": {
+      "type": "string"
+    },
+    "country": {
+      "type": "string"
+    },
+    "country_code": {
+      "type": "string"
+    },
+    "country_name": {
+      "type": "string"
+    },
+    "county_taxes": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "currency": {
+      "type": "string"
+    },
+    "customer_email": {
+      "format": "email",
+      "type": "string"
+    },
+    "domain": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "eligible_for_payments": {
+      "type": "boolean"
+    },
+    "email": {
+      "format": "email",
+      "type": "string"
+    },
+    "enabled_presentment_currencies": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "finances": {
+      "type": "boolean"
+    },
+    "google_apps_domain": {
+      "format": "hostname",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "google_apps_login_enabled": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "has_discounts": {
+      "type": "boolean"
+    },
+    "has_gift_cards": {
+      "type": "boolean"
+    },
+    "has_storefront": {
+      "type": "boolean"
+    },
+    "iana_timezone": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "id": {
+      "type": "integer"
+    },
+    "latitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "longitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "marketing_sms_consent_enabled_at_checkout": {
+      "type": "boolean"
+    },
+    "money_format": {
+      "type": "string"
+    },
+    "money_in_emails_format": {
+      "type": "string"
+    },
+    "money_with_currency_format": {
+      "type": "string"
+    },
+    "money_with_currency_in_emails_format": {
+      "type": "string"
+    },
+    "multi_location_enabled": {
+      "type": "boolean"
+    },
+    "myshopify_domain": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "password_enabled": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "phone": {
+      "type": "string"
+    },
+    "plan_display_name": {
+      "type": "string"
+    },
+    "plan_name": {
+      "type": "string"
+    },
+    "pre_launch_enabled": {
+      "type": "boolean"
+    },
+    "primary_locale": {
+      "type": "string"
+    },
+    "primary_location_id": {
+      "type": "integer"
+    },
+    "province": {
+      "type": "string"
+    },
+    "province_code": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "requires_extra_payments_agreement": {
+      "type": "boolean"
+    },
+    "setup_required": {
+      "type": "boolean"
+    },
+    "shop_owner": {
+      "type": "string"
+    },
+    "source": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "tax_shipping": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "taxes_included": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "timezone": {
+      "type": "string"
+    },
+    "transactional_sms_disabled": {
+      "type": "boolean"
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "weight_unit": {
+      "type": "string"
+    },
+    "zip": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "address1",
+    "address2",
+    "auto_configure_tax_inclusivity",
+    "checkout_api_supported",
+    "city",
+    "country",
+    "country_code",
+    "country_name",
+    "county_taxes",
+    "created_at",
+    "currency",
+    "customer_email",
+    "domain",
+    "eligible_for_payments",
+    "email",
+    "enabled_presentment_currencies",
+    "finances",
+    "google_apps_domain",
+    "google_apps_login_enabled",
+    "has_discounts",
+    "has_gift_cards",
+    "has_storefront",
+    "iana_timezone",
+    "id",
+    "latitude",
+    "longitude",
+    "marketing_sms_consent_enabled_at_checkout",
+    "money_format",
+    "money_in_emails_format",
+    "money_with_currency_format",
+    "money_with_currency_in_emails_format",
+    "multi_location_enabled",
+    "myshopify_domain",
+    "name",
+    "password_enabled",
+    "phone",
+    "plan_display_name",
+    "plan_name",
+    "pre_launch_enabled",
+    "primary_locale",
+    "primary_location_id",
+    "province",
+    "province_code",
+    "requires_extra_payments_agreement",
+    "setup_required",
+    "shop_owner",
+    "source",
+    "tax_shipping",
+    "taxes_included",
+    "timezone",
+    "transactional_sms_disabled",
+    "updated_at",
+    "weight_unit",
+    "zip"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object"
+}

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

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object"
+}

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

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object"
+}

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

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "billing_attempt_expected_date": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "contract_edit": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "cycle_end_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "cycle_index": {
+      "type": "integer"
+    },
+    "cycle_start_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "edited": {
+      "type": "boolean"
+    },
+    "skipped": {
+      "type": "boolean"
+    },
+    "subscription_contract_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "billing_attempt_expected_date",
+    "contract_edit",
+    "cycle_end_at",
+    "cycle_index",
+    "cycle_start_at",
+    "edited",
+    "skipped",
+    "subscription_contract_id"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "billing_attempt_expected_date": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "contract_edit": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "cycle_end_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "cycle_index": {
+      "type": "integer"
+    },
+    "cycle_start_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "edited": {
+      "type": "boolean"
+    },
+    "skipped": {
+      "type": "boolean"
+    },
+    "subscription_contract_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "billing_attempt_expected_date",
+    "contract_edit",
+    "cycle_end_at",
+    "cycle_index",
+    "cycle_start_at",
+    "edited",
+    "skipped",
+    "subscription_contract_id"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "billing_attempt_expected_date": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "contract_edit": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "cycle_end_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "cycle_index": {
+      "type": "integer"
+    },
+    "cycle_start_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "edited": {
+      "type": "boolean"
+    },
+    "skipped": {
+      "type": "boolean"
+    },
+    "subscription_contract_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "billing_attempt_expected_date",
+    "contract_edit",
+    "cycle_end_at",
+    "cycle_index",
+    "cycle_start_at",
+    "edited",
+    "skipped",
+    "subscription_contract_id"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "billing_attempt_expected_date": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "contract_edit": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "cycle_end_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "cycle_index": {
+      "type": "integer"
+    },
+    "cycle_start_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "edited": {
+      "type": "boolean"
+    },
+    "skipped": {
+      "type": "boolean"
+    },
+    "subscription_contract_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "billing_attempt_expected_date",
+    "contract_edit",
+    "cycle_end_at",
+    "cycle_index",
+    "cycle_start_at",
+    "edited",
+    "skipped",
+    "subscription_contract_id"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "billing_attempt_expected_date": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "contract_edit": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "cycle_end_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "cycle_index": {
+      "type": "integer"
+    },
+    "cycle_start_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "edited": {
+      "type": "boolean"
+    },
+    "skipped": {
+      "type": "boolean"
+    },
+    "subscription_contract_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "billing_attempt_expected_date",
+    "contract_edit",
+    "cycle_end_at",
+    "cycle_index",
+    "cycle_start_at",
+    "edited",
+    "skipped",
+    "subscription_contract_id"
+  ],
+  "type": "object"
+}

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

@@ -0,0 +1,93 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_customer_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "admin_graphql_api_origin_order_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "billing_policy": {
+      "properties": {
+        "interval": {
+          "type": "string"
+        },
+        "interval_count": {
+          "type": "integer"
+        },
+        "max_cycles": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "min_cycles": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "interval",
+        "interval_count",
+        "max_cycles",
+        "min_cycles"
+      ],
+      "type": "object"
+    },
+    "currency_code": {
+      "type": "string"
+    },
+    "customer_id": {
+      "type": "integer"
+    },
+    "delivery_policy": {
+      "properties": {
+        "interval": {
+          "type": "string"
+        },
+        "interval_count": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "interval",
+        "interval_count"
+      ],
+      "type": "object"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "origin_order_id": {
+      "type": "integer"
+    },
+    "revision_id": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_customer_id",
+    "admin_graphql_api_id",
+    "admin_graphql_api_origin_order_id",
+    "billing_policy",
+    "currency_code",
+    "customer_id",
+    "delivery_policy",
+    "id",
+    "origin_order_id",
+    "revision_id",
+    "status"
+  ],
+  "type": "object"
+}