fluentcart-developer 2.3.3 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (655) hide show
  1. package/dist/cards/fluentcart/tools.d.ts.map +1 -1
  2. package/dist/cards/fluentcart/tools.js +2368 -2323
  3. package/dist/cards/fluentcart/tools.js.map +1 -1
  4. package/dist/paths.d.ts +1 -1
  5. package/dist/paths.d.ts.map +1 -1
  6. package/dist/paths.js +1 -1
  7. package/dist/paths.js.map +1 -1
  8. package/dist/reference-reader.d.ts +32 -1
  9. package/dist/reference-reader.d.ts.map +1 -1
  10. package/dist/reference-reader.js +111 -22
  11. package/dist/reference-reader.js.map +1 -1
  12. package/dist/server.d.ts.map +1 -1
  13. package/dist/server.js +8 -1
  14. package/dist/server.js.map +1 -1
  15. package/dist/skills/fluentcart-developer/SKILL.md +66 -538
  16. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
  17. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
  18. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
  19. package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
  20. package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
  21. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
  22. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
  23. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
  24. package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
  25. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
  26. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
  27. package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
  28. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
  29. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
  30. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
  31. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
  33. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
  34. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
  35. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
  36. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
  37. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
  38. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
  39. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
  40. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
  41. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
  42. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
  43. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
  44. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
  45. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
  46. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
  47. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
  48. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
  49. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
  50. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
  51. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
  52. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
  53. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
  54. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
  55. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
  56. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
  57. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
  58. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
  59. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
  60. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
  61. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
  62. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
  63. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
  64. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
  66. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
  67. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
  68. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
  69. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
  70. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
  71. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
  72. package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
  73. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
  74. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
  75. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
  76. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
  77. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
  78. package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
  79. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
  80. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
  81. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
  82. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
  83. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
  84. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
  89. package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
  90. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
  91. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
  100. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
  101. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
  102. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
  103. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
  110. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
  111. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
  112. package/dist/skills/fluentcart-developer/references/index.md +625 -0
  113. package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
  114. package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
  115. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
  116. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
  117. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
  118. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
  119. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
  120. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
  121. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
  122. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
  123. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
  124. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
  125. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
  129. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
  130. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
  131. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
  132. package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
  133. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
  134. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
  135. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
  136. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
  137. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
  138. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
  139. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
  140. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
  141. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
  142. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
  143. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
  591. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
  592. package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
  593. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
  594. package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
  595. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
  596. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
  597. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
  598. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
  599. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
  600. package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
  601. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
  602. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
  603. package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
  604. package/dist/version.d.ts +1 -1
  605. package/dist/version.js +1 -1
  606. package/package.json +1 -1
  607. package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
  608. package/dist/skills/fluentcart-developer/.mcp.json +0 -11
  609. package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
  610. package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
  611. package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
  612. package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
  613. package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
  614. package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
  615. package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
  616. package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
  617. package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
  618. package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
  619. package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
  620. package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
  621. package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
  622. package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
  623. package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
  624. package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
  625. package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
  626. package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
  627. package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
  628. package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
  629. package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
  630. package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
  631. package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
  632. package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
  633. package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
  634. package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
  635. package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
  636. package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
  637. package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
  638. package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
  639. package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
  640. package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
  641. package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
  642. package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
  643. package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
  644. package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
  645. package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
  646. package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
  647. package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
  648. package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
  649. package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
  650. package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
  651. package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
  652. package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
  653. package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
  654. package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
  655. package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
@@ -1,1931 +0,0 @@
1
- # Paddle Payment Gateway Case Study
2
-
3
- ## Settings Field Schema Reference
4
-
5
- # Payment Gateway Settings Fields [](#payment-gateway-settings-fields)
6
-
7
- This guide explains how to build settings fields for your custom payment gateway in FluentCart. The `fields()` method in your main gateway class (ex: YourGateway.php) returns a schema that FluentCart uses to render settings fields in the admin interface.
8
- ## Basic Structure [](#basic-structure)
9
-
10
- The `fields()` method returns an associative array where each key is a field ID and each value is an array defining the field properties:php
11
- ```
12
- public function fields(): array
13
- {
14
- return [
15
- 'field_id' => [
16
- 'type' => 'text', // Field type (required)
17
- 'label' => 'Field Label', // Display label
18
- 'value' => 'default_value', // Default value
19
- // ... other properties
20
- ],
21
- // ... more fields
22
- ];
23
- }```
24
-
25
- ## Common Field Properties [](#common-field-properties)
26
-
27
- All field types support these common properties:
28
-
29
- | Property | Description |
30
- | --- | --- |
31
- | `type` | Required. Defines the field type (see available types below) |
32
- | `label` | The field label displayed to the user |
33
- | `value` | Default value for the field |
34
- | `placeholder` | Placeholder text for input fields |
35
- | `tooltip` | Brief tooltip displayed on hover |
36
- | `description` | Brief description displayed below the field |
37
- | `max_length` | Maximum length of the text/input/password field |
38
- | `disabled` | Whether the field is disabled (boolean) |
39
- ## Available Field Types [](#available-field-types)
40
-
41
- ### Text Fields [](#text-fields)
42
-
43
- #### `text`, `input`, `password`, `email`, `number` [](#text-input-password-email-number)
44
-
45
- Basic input fields for text, passwords, number(with min, max), and emails.php
46
- ```
47
- 'api_key' => [
48
- 'type' => 'text',
49
- 'label' => __('API Key', 'your-plugin'),
50
- 'placeholder' => __('Enter your API key', 'your-plugin'),
51
- 'help_text' => __('Find this in your gateway dashboard', 'your-plugin'),
52
- ],
53
- 'secret_key' => [
54
- 'type' => 'password',
55
- 'label' => __('Secret Key', 'your-plugin'),
56
- 'placeholder' => __('Enter your secret key', 'your-plugin'),
57
- ],```
58
-
59
- ### Toggle Fields [](#toggle-fields)
60
-
61
- #### `enable` (Toggle Switch) [](#enable-toggle-switch)
62
-
63
- Creates a toggle switch for enabling/disabling features.php
64
- ```
65
- 'is_active' => [
66
- 'type' => 'enable',
67
- 'label' => __('Enable Gateway', 'your-plugin'),
68
- 'value' => 'yes', // or 'no'
69
- ],```
70
-
71
- #### `checkbox` [](#checkbox)
72
-
73
- Creates a single checkbox.php
74
- ```
75
- 'save_card' => [
76
- 'type' => 'checkbox',
77
- 'label' => __('Save Customer Cards', 'your-plugin'),
78
- 'value' => 'no',
79
- 'tooltip' => __('Allow customers to save payment methods', 'your-plugin'),
80
- ],```
81
-
82
- ### Selection Fields [](#selection-fields)
83
-
84
- #### `select` [](#select)
85
-
86
- Creates a dropdown select menu.php
87
- ```
88
- 'checkout_mode' => [
89
- 'type' => 'select',
90
- 'label' => __('Checkout Mode', 'your-plugin'),
91
- 'options' => [
92
- ['value' => 'hosted', 'label' => __('Hosted Checkout', 'your-plugin')],
93
- ['value' => 'embedded', 'label' => __('Embedded Checkout', 'your-plugin')],
94
- ],
95
- ],```
96
-
97
- #### `radio` [](#radio)
98
-
99
- Creates a group of radio buttons.php
100
- ```
101
- 'transaction_type' => [
102
- 'type' => 'radio',
103
- 'label' => __('Transaction Type', 'your-plugin'),
104
- 'options' => [
105
- 'sale' => __('Direct Sale', 'your-plugin'),
106
- 'authorize' => __('Authorize Only', 'your-plugin'),
107
- ],
108
- 'value' => 'sale',
109
- ],```
110
-
111
- #### `checkbox_group` [](#checkbox-group)
112
-
113
- Creates a group of checkboxes.php
114
- ```
115
- 'accepted_cards' => [
116
- 'type' => 'checkbox_group',
117
- 'title' => __('Accepted Cards', 'your-plugin'),
118
- 'desc' => __('Select the card types to accept', 'your-plugin'),
119
- 'options' => [
120
- 'visa' => __('Visa', 'your-plugin'),
121
- 'mastercard' => __('Mastercard', 'your-plugin'),
122
- 'amex' => __('American Express', 'your-plugin'),
123
- ],
124
- ],```
125
-
126
- ### Display Fields [](#display-fields)
127
-
128
- #### `notice` [](#notice)
129
-
130
- Displays an informational notice without input.php
131
- ```
132
- 'setup_notice' => [
133
- 'type' => 'notice',
134
- 'value' => '<p>Configure your gateway settings below.</p>',
135
- ],```
136
-
137
- #### `html_attr` [](#html-attr)
138
-
139
- Displays custom HTML content.php
140
- ```
141
- 'webhook_info' => [
142
- 'type' => 'html_attr',
143
- 'value' => '<div class="fc-gateway-webhook-info">Webhook URL: ' . $this->getWebhookUrl() . '</div>',
144
- ],```
145
-
146
- ### Color Selector [](#color-selector)
147
-
148
- #### `color` [](#color)
149
-
150
- Creates a color picker.php
151
- ```
152
- 'button_color' => [
153
- 'type' => 'color',
154
- 'label' => __('Button Color', 'your-plugin'),
155
- 'value' => '#3498db',
156
- ],```
157
-
158
- ### Advanced Field Groups [](#advanced-field-groups)
159
-
160
- #### `tabs` [](#tabs)
161
-
162
- Creates a tabbed interface, useful for separating test and live credentials.php
163
- ```
164
- 'payment_mode' => [
165
- 'type' => 'tabs',
166
- 'schema' => [
167
- [
168
- 'type' => 'tab',
169
- 'label' => __('Live credentials', 'your-plugin'),
170
- 'value' => 'live',
171
- 'schema' => [
172
- 'live_api_key' => [
173
- 'type' => 'text',
174
- 'label' => __('Live API Key', 'your-plugin'),
175
- ],
176
- 'live_secret_key' => [
177
- 'type' => 'password',
178
- 'label' => __('Live Secret Key', 'your-plugin'),
179
- ],
180
- ]
181
- ],
182
- [
183
- 'type' => 'tab',
184
- 'label' => __('Test credentials', 'your-plugin'),
185
- 'value' => 'test',
186
- 'schema' => [
187
- 'test_api_key' => [
188
- 'type' => 'text',
189
- 'label' => __('Test API Key', 'your-plugin'),
190
- ],
191
- 'test_secret_key' => [
192
- 'type' => 'password',
193
- 'label' => __('Test Secret Key', 'your-plugin'),
194
- ],
195
- ]
196
- ]
197
- ]
198
- ],```
199
-
200
- ## Complete Example [](#complete-example)
201
-
202
- Here's a complete example of a `fields()` method in a gateway class:php
203
- ```
204
- public function fields(): array
205
- {
206
- // Get webhook URL
207
- $webhookUrl = $this->getWebhookUrl();
208
-
209
- // Test mode credentials
210
- $testSchema = [
211
- 'test_api_key' => [
212
- 'type' => 'text',
213
- 'label' => __('Test API Key', 'your-plugin'),
214
- 'placeholder' => __('Enter your test API key', 'your-plugin'),
215
- ],
216
- 'test_secret_key' => [
217
- 'type' => 'password',
218
- 'label' => __('Test Secret Key', 'your-plugin'),
219
- 'placeholder' => __('Enter your test secret key', 'your-plugin'),
220
- ],
221
- ];
222
-
223
- // Live mode credentials
224
- $liveSchema = [
225
- 'live_api_key' => [
226
- 'type' => 'text',
227
- 'label' => __('Live API Key', 'your-plugin'),
228
- 'placeholder' => __('Enter your live API key', 'your-plugin'),
229
- ],
230
- 'live_secret_key' => [
231
- 'type' => 'password',
232
- 'label' => __('Live Secret Key', 'your-plugin'),
233
- 'placeholder' => __('Enter your live secret key', 'your-plugin'),
234
- ],
235
- ];
236
-
237
- return [
238
- 'setup_notice' => [
239
- 'type' => 'notice',
240
- 'value' => '<p>' . __('Configure your gateway settings below.', 'your-plugin') . '</p>',
241
- ],
242
- 'payment_mode' => [
243
- 'type' => 'tabs',
244
- 'schema' => [
245
- [
246
- 'type' => 'tab',
247
- 'label' => __('Live credentials', 'your-plugin'),
248
- 'value' => 'live',
249
- 'schema' => $liveSchema
250
- ],
251
- [
252
- 'type' => 'tab',
253
- 'label' => __('Test credentials', 'your-plugin'),
254
- 'value' => 'test',
255
- 'schema' => $testSchema
256
- ]
257
- ]
258
- ],
259
- 'checkout_title' => [
260
- 'type' => 'text',
261
- 'label' => __('Checkout Title', 'your-plugin'),
262
- 'value' => __('Credit Card Payment', 'your-plugin'),
263
- 'placeholder' => __('Appears on the checkout page', 'your-plugin'),
264
- ],
265
- 'checkout_description' => [
266
- 'type' => 'textarea',
267
- 'label' => __('Checkout Description', 'your-plugin'),
268
- 'value' => __('Pay securely using your credit card.', 'your-plugin'),
269
- 'placeholder' => __('Appears on the checkout page', 'your-plugin'),
270
- ],
271
- 'webhook_info' => [
272
- 'type' => 'html_attr',
273
- 'value' => '<div class="fc-webhook-info">' .
274
- '<strong>' . __('Webhook URL:', 'your-plugin') . '</strong><br>' .
275
- '<code>' . $webhookUrl . '</code><br>' .
276
- __('Configure this URL in your gateway dashboard to receive payment notifications.', 'your-plugin') .
277
- '</div>',
278
- ],
279
- 'debug_mode' => [
280
- 'type' => 'checkbox',
281
- 'label' => __('Debug Mode', 'your-plugin'),
282
- 'value' => 'no',
283
- 'tooltip' => __('Enable logging for debugging purposes', 'your-plugin'),
284
- ],
285
- ];
286
- }```
287
-
288
- ## Accessing Settings Values [](#accessing-settings-values)
289
-
290
- Once settings are saved, you can access them in your gateway class using the `$this->settings->get()` method:php
291
- ```
292
- // Get a setting value
293
- $apiKey = $this->settings->get('api_key');
294
-
295
- // Get a nested setting value based on payment mode
296
- $mode = $this->settings->get('payment_mode');
297
- $apiKey = $this->settings->get($mode . '_api_key');```
298
-
299
- ## Best Practices [](#best-practices)
300
-
301
- - **Group Related Settings**: Use tabs to separate test and live credentials
302
- - **Provide Clear Labels**: Use descriptive labels and help text
303
- - **Include Validation**: Use appropriate field types for data validation
304
- - **Secure Sensitive Data**: Use password fields for API secrets
305
- - **Add Webhook Instructions**: Show webhook URLs and instructions when applicable
306
-
307
- ## Available Field Types Reference [](#available-field-types-reference)
308
-
309
- | Field Type | Description |
310
- | --- | --- |
311
- | `text`, `input` | Standard text input |
312
- | `password` | Password input (masked text) |
313
- | `email` | Email input with validation |
314
- | `textarea` | Multi-line text input |
315
- | `select` | Dropdown selection |
316
- | `radio` | Radio button group |
317
- | `checkbox` | Single checkbox toggle |
318
- | `checkbox_group` | Multiple checkbox group |
319
- | `enable` | Toggle switch |
320
- | `color` | Color picker |
321
- | `notice` | Information display |
322
- | `html_attr` | Raw HTML content |
323
- | `tabs` | Tabbed interface |
324
- For more complete payment method integration examples, refer to the [Complete Payment Gateway Integration Guide](https://dev.fluentcart.com/payment-methods-integration/quick-implementation.html).
325
-
326
- ---
327
-
328
- ## Paddle Core Implementation Detail
329
-
330
- # Paddle Gateway Case Study [](#paddle-gateway-case-study)
331
-
332
- Learn from a real-world implementation by examining how the Paddle payment gateway was integrated into FluentCart Pro. This case study provides practical insights and patterns you can apply to your own gateway development.
333
- ## Overview [](#overview)
334
-
335
- The Paddle Gateway demonstrates a **complete production-ready implementation** featuring:
336
-
337
- - **One-time payments** with full transaction lifecycle
338
- - **Subscription payments** with recurring billing management
339
- - **Comprehensive webhook/IPN handling** for real-time updates
340
- - **Custom checkout experience** with UI customization
341
- - **Multi-environment support** (test/live modes)
342
- - **Advanced settings management** with dynamic configuration
343
- - **Frontend integration** with JavaScript SDK
344
- - **Error handling and logging** for production reliability
345
- - **Security best practices** with signature verification
346
-
347
- This case study shows how to implement **all major payment gateway features** that third-party developers typically need.
348
- ## Architecture Analysis [](#architecture-analysis)
349
-
350
- ### File Structure [](#file-structure)
351
-
352
- ```
353
- fluent-cart-pro/app/Modules/PaymentMethods/PaddleGateway/
354
- ├── Paddle.php # Main gateway class
355
- ├── PaddleSettings.php # Settings management
356
- ├── PaddleSubscriptions.php # Subscription handling
357
- ├── PaddleHelper.php # Utility functions
358
- ├── Processor.php # Payment processing
359
- ├── Confirmations.php # Payment confirmations
360
- ├── Price.php # Price management
361
- ├── Product.php # Product handling
362
- ├── SubscriptionsManager.php # Subscription lifecycle
363
- ├── API/
364
- │ └── API.php # API communication
365
- └── Webhook/
366
- └── IPN.php # Web hook processing```
367
-
368
- ## Main Gateway Implementation [](#main-gateway-implementation)
369
-
370
- ### Core Gateway Class [](#core-gateway-class)
371
- php
372
- ```
373
- class Paddle extends AbstractPaymentGateway
374
- {
375
- private $methodSlug = 'paddle';
376
-
377
- public array $supportedFeatures = [
378
- 'payment',
379
- 'refund',
380
- 'webhook',
381
- 'subscriptions',
382
- 'custom_payment'
383
- ];
384
-
385
- public function __construct()
386
- {
387
- parent::__construct(
388
- new PaddleSettings(),
389
- new PaddleSubscriptions()
390
- );
391
-
392
- // Register custom checkout filter
393
- add_filter('fluent_cart/payment_methods_with_custom_checkout_buttons', function ($methods) {
394
- $methods[] = 'paddle';
395
- return $methods;
396
- });
397
- }
398
- }```
399
-
400
- **Key Insights:**
401
-
402
- - Uses composition pattern with separate settings and subscription classes
403
- - Declares all supported features upfront
404
- - Registers custom checkout behavior during construction
405
-
406
- ### Gateway Metadata [](#gateway-metadata)
407
- php
408
- ```
409
- public function meta(): array
410
- {
411
- return [
412
- 'title' => __('Paddle', 'fluent-cart-pro'),
413
- 'route' => 'paddle',
414
- 'slug' => 'paddle',
415
- 'description' => __('Pay securely with Paddle - Complete payment solution', 'fluent-cart-pro'),
416
- 'logo' => Vite::getAssetUrl("images/payment-methods/paddle-logo.svg"),
417
- 'icon' => Vite::getAssetUrl("images/payment-methods/paddle-logo.svg"),
418
- 'brand_color' => '#7c3aed',
419
- 'status' => $this->settings->get('is_active') === 'yes',
420
- 'upcoming' => false,
421
- 'supported_features' => $this->supportedFeatures,
422
- 'tag' => 'beta'
423
- ];
424
- }```
425
-
426
- **Key Insights:**
427
-
428
- - Uses asset management system (Vite) for icons and logos
429
- - Includes visual branding with brand colors
430
- - Shows development status with tags
431
- - Status reflects actual settings configuration
432
-
433
- ## Settings Architecture [](#settings-architecture)
434
-
435
- ### Hierarchical Settings Structure [](#hierarchical-settings-structure)
436
- php
437
- ```
438
- class PaddleSettings extends BaseGatewaySettings
439
- {
440
- public $methodHandler = 'fluent_cart_payment_settings_paddle';
441
-
442
- public static function getDefaults()
443
- {
444
- return [
445
- 'is_active' => 'no',
446
- 'provider' => 'api_keys',
447
- 'live_api_key' => '',
448
- 'live_client_token' => '',
449
- 'live_webhook_secret' => '',
450
- 'test_api_key' => '',
451
- 'test_client_token' => '',
452
- 'test_webhook_secret' => '',
453
- 'payment_mode' => 'test',
454
- 'tax_mode' => 'internal',
455
- // UI customization options
456
- 'paddle_checkout_theme' => 'light',
457
- 'paddle_checkout_button_text' => 'Pay with Paddle',
458
- 'paddle_checkout_button_color' => '',
459
- // ... more settings
460
- ];
461
- }
462
- }```
463
-
464
- **Key Insights:**
465
-
466
- - Separates live and test credentials
467
- - Includes UI customization options
468
- - Uses descriptive setting keys
469
- - Provides sensible defaults
470
-
471
- ### Environment-Aware API Keys [](#environment-aware-api-keys)
472
- php
473
- ```
474
- public function getApiKey($mode = '')
475
- {
476
- if (!$mode) {
477
- $mode = $this->getMode();
478
- }
479
- return $this->get($mode . '_api_key');
480
- }
481
-
482
- public function getMode()
483
- {
484
- return $this->get('payment_mode');
485
- }```
486
-
487
- **Key Insights:**
488
-
489
- - Dynamic key resolution based on mode
490
- - Centralized mode management
491
- - Consistent naming patterns
492
-
493
- ### Important: Payment Mode vs Order Mode [](#important-payment-mode-vs-order-mode)
494
-
495
- FluentCart distinguishes between two different "modes":
496
-
497
- -
498
- **Payment Mode** (`payment_mode` in settings): The current test/live configuration in payment gateway settingsphp
499
- ```
500
- $this->settings->getMode(); // Returns current payment mode from settings```
501
-
502
- -
503
- **Order Mode** (`$order->mode`): The mode captured at checkout time and stored with the orderphp
504
- ```
505
- $order->mode; // Returns the mode when this specific order was placed```
506
-
507
- **Usage Guidelines:**
508
-
509
- - **For API calls**: Use order mode from `$order->mode` to ensure consistency with the original transaction
510
- - **For settings/configuration**: Use payment mode from `$this->settings->getMode()`
511
- - **For transaction storage**: Always store `payment_mode` as `$order->mode` to preserve checkout-time context
512
- - **For transaction URLs**: Use the stored `payment_mode` from transaction data
513
-
514
- ## Complete Payment Processing Implementation [](#complete-payment-processing-implementation)
515
-
516
- ### One-Time Payment Flow [](#one-time-payment-flow)
517
- php
518
- ```
519
- class Processor
520
- {
521
- public function handleSinglePayment(PaymentInstance $paymentInstance)
522
- {
523
- $order = $paymentInstance->order;
524
- $transaction = $paymentInstance->transaction;
525
-
526
- // Prepare payment data for external API
527
- $paymentData = [
528
- 'items' => $this->prepareOrderItems($order),
529
- 'customer' => [
530
- 'email' => $order->email,
531
- 'name' => $order->billing_name,
532
- 'address' => $this->prepareAddress($order)
533
- ],
534
- 'custom_data' => [
535
- 'fct_transaction_hash' => $transaction->uuid,
536
- 'fct_order_id' => $order->id
537
- ],
538
- 'checkout' => [
539
- 'url' => $this->getCheckoutUrl($order),
540
- 'success_url' => $this->getSuccessUrl($transaction),
541
- 'cancel_url' => $this->getCancelUrl($order)
542
- ]
543
- ];
544
-
545
- // Create payment at external gateway
546
- // Always explicitly pass the order mode for consistency
547
- $response = API::createPaddleObject('transactions', $paymentData, $order->mode);
548
-
549
- if (is_wp_error($response)) {
550
- return [
551
- 'success' => false,
552
- 'message' => $response->get_error_message()
553
- ];
554
- }
555
-
556
- // Store external payment ID for webhook processing
557
- $transaction->update([
558
- 'vendor_charge_id' => $response['data']['id'],
559
- 'payment_mode' => $order->mode, // Store order mode from checkout time
560
- 'meta' => array_merge($transaction->meta ?? [], [
561
- 'gateway_response' => $response['data']
562
- ])
563
- ]);
564
-
565
- return [
566
- 'success' => true,
567
- 'redirect_url' => $response['data']['checkout']['url'],
568
- 'transaction_id' => $response['data']['id']
569
- ];
570
- }
571
-
572
- private function prepareOrderItems($order)
573
- {
574
- $items = [];
575
- foreach ($order->items as $item) {
576
- $items[] = [
577
- 'price_id' => $item->meta['external_price_id'] ?? null,
578
- 'quantity' => $item->quantity,
579
- 'name' => $item->title,
580
- 'description' => $item->description,
581
- 'unit_price' => $item->unit_price * 100, // Convert to cents
582
- 'total_price' => $item->total * 100
583
- ];
584
- }
585
- return $items;
586
- }
587
- }```
588
-
589
- **Key Insights:**
590
-
591
- - Comprehensive order data mapping to external gateway format
592
- - Custom data inclusion for webhook correlation
593
- - Proper URL handling for checkout flow
594
- - Error handling with WP_Error integration
595
- - Transaction metadata storage for later processing
596
-
597
- ### Subscription Payment Flow [](#subscription-payment-flow)
598
- php
599
- ```
600
- public function handleSubscriptionPayment(PaymentInstance $paymentInstance)
601
- {
602
- $order = $paymentInstance->order;
603
- $subscription = $paymentInstance->subscription;
604
- $transaction = $paymentInstance->transaction;
605
-
606
- // Prepare subscription-specific data
607
- $subscriptionData = [
608
- 'items' => $this->prepareSubscriptionItems($order, $subscription),
609
- 'customer' => $this->prepareCustomerData($order),
610
- 'billing_cycle' => $this->mapBillingCycle($subscription),
611
- 'collection_mode' => 'automatic',
612
- 'proration_billing_mode' => 'prorated_immediately',
613
- 'custom_data' => [
614
- 'fct_subscription_hash' => $subscription->uuid,
615
- 'fct_order_id' => $order->id,
616
- 'fct_transaction_hash' => $transaction->uuid
617
- ],
618
- 'checkout' => [
619
- 'url' => $this->getCheckoutUrl($order),
620
- 'success_url' => $this->getSuccessUrl($transaction),
621
- 'cancel_url' => $this->getCancelUrl($order)
622
- ]
623
- ];
624
-
625
- // Add trial period if applicable
626
- if ($subscription->trial_days > 0) {
627
- $subscriptionData['scheduled_change'] = [
628
- 'action' => 'resume',
629
- 'effective_at' => gmdate('Y-m-d\TH:i:s\Z', strtotime('+' . $subscription->trial_days . ' days'))
630
- ];
631
- }
632
-
633
- // Create subscription at external gateway
634
- // Always explicitly pass the order mode for consistency
635
- $response = API::createPaddleObject('subscriptions', $subscriptionData, $order->mode);
636
-
637
- if (is_wp_error($response)) {
638
- return [
639
- 'success' => false,
640
- 'message' => $response->get_error_message()
641
- ];
642
- }
643
-
644
- // Store subscription and transaction data
645
- $subscription->update([
646
- 'vendor_subscription_id' => $response['data']['id'],
647
- 'status' => 'pending',
648
- 'meta' => array_merge($subscription->meta ?? [], [
649
- 'gateway_response' => $response['data'],
650
- 'billing_cycle_data' => $response['data']['billing_cycle'] ?? []
651
- ])
652
- ]);
653
-
654
- $transaction->update([
655
- 'vendor_charge_id' => $response['data']['id'],
656
- 'subscription_id' => $subscription->id,
657
- 'payment_mode' => $order->mode, // Store order mode from checkout time
658
- 'meta' => array_merge($transaction->meta ?? [], [
659
- 'subscription_data' => $response['data']
660
- ])
661
- ]);
662
-
663
- return [
664
- 'success' => true,
665
- 'redirect_url' => $response['data']['checkout']['url'],
666
- 'subscription_id' => $response['data']['id']
667
- ];
668
- }
669
-
670
- private function prepareSubscriptionItems($order, $subscription)
671
- {
672
- $items = [];
673
- foreach ($order->items as $item) {
674
- // Map to subscription pricing structure
675
- $items[] = [
676
- 'price_id' => $item->meta['recurring_price_id'] ?? $item->meta['external_price_id'],
677
- 'quantity' => $item->quantity,
678
- 'name' => $item->title,
679
- 'description' => $item->description,
680
- 'billing_cycle' => [
681
- 'interval' => $this->mapInterval($subscription->billing_interval),
682
- 'frequency' => $subscription->billing_interval_count ?? 1
683
- ],
684
- 'unit_price' => $item->unit_price * 100,
685
- 'trial_period' => $subscription->trial_days > 0 ? [
686
- 'interval' => 'day',
687
- 'frequency' => $subscription->trial_days
688
- ] : null
689
- ];
690
- }
691
- return $items;
692
- }
693
-
694
- private function mapBillingCycle($subscription)
695
- {
696
- $intervalMap = [
697
- 'day' => 'day',
698
- 'week' => 'week',
699
- 'month' => 'month',
700
- 'year' => 'year'
701
- ];
702
-
703
- return [
704
- 'interval' => $intervalMap[$subscription->billing_interval] ?? 'month',
705
- 'frequency' => $subscription->billing_interval_count ?? 1
706
- ];
707
- }```
708
-
709
- **Key Insights:**
710
-
711
- - Subscription-specific data structure with billing cycles
712
- - Trial period handling with scheduled changes
713
- - Separate subscription and transaction storage
714
- - Complex item mapping for recurring pricing
715
- - Comprehensive metadata storage for webhook processing
716
-
717
- ## Payment Processing [](#payment-processing)
718
-
719
- ### Payment Delegation Pattern [](#payment-delegation-pattern)
720
- php
721
- ```
722
- public function makePaymentFromPaymentInstance(PaymentInstance $paymentInstance)
723
- {
724
- $order = $paymentInstance->order;
725
-
726
- if ($paymentInstance->subscription) {
727
- return (new Processor())->handleSubscriptionPayment($paymentInstance);
728
- }
729
-
730
- return (new Processor())->handleSinglePayment($paymentInstance);
731
- }```
732
-
733
- **Key Insights:**
734
-
735
- - Delegates to specialized processor class
736
- - Clean separation between single and subscription payments
737
- - Maintains single responsibility principle
738
-
739
- ### API Communication Layer [](#api-communication-layer)
740
- php
741
- ```
742
- class API
743
- {
744
- public static function makeRequest($endpoint, $data = [], $method = 'POST', $mode = '')
745
- {
746
- $settings = self::getSettings();
747
-
748
- if (!$mode) {
749
- $mode = $settings->getMode(); // Get current payment mode from settings
750
- }
751
-
752
- $apiKey = $settings->getApiKey($mode);
753
- if (empty($apiKey)) {
754
- return new \WP_Error('paddle_api_key_missing', 'API key is missing');
755
- }
756
-
757
- // Hosts are placeholders — swap in the gateway's own documented sandbox and live API base hosts.
758
- $baseUrl = $mode === 'test'
759
- ? 'https://sandbox-api.example.com'
760
- : 'https://api.example.com';
761
-
762
- $response = wp_remote_request($baseUrl . $endpoint, [
763
- 'method' => $method,
764
- 'headers' => [
765
- 'Authorization' => 'Bearer ' . $apiKey,
766
- 'Content-Type' => 'application/json',
767
- ],
768
- 'body' => $method !== 'GET' ? json_encode($data) : null,
769
- 'timeout' => 30
770
- ]);
771
-
772
- // Error handling...
773
- return $decodedBody;
774
- }
775
- }```
776
-
777
- **Key Insights:**
778
-
779
- - Environment-aware endpoint selection
780
- - Consistent error handling with WP_Error
781
- - Proper timeout configuration
782
- - Bearer token authentication
783
- - **Fallback to settings mode** when no mode parameter provided
784
- - **Best Practice**: Always explicitly pass the mode parameter for consistency
785
-
786
- ## Comprehensive Webhook/IPN Implementation [](#comprehensive-webhook-ipn-implementation)
787
-
788
- ### Complete Webhook Processing Architecture [](#complete-webhook-processing-architecture)
789
-
790
- The Paddle gateway implements a sophisticated three-layer webhook processing system that handles all payment and subscription events:php
791
- ```
792
- class IPN
793
- {
794
- private PaddleSettings $settings;
795
-
796
- public function __construct()
797
- {
798
- $this->settings = new PaddleSettings();
799
- }
800
-
801
- /**
802
- * Initialize all webhook event handlers
803
- */
804
- public function init(): void
805
- {
806
- // Payment lifecycle events
807
- add_action('fluent_cart/payments/paddle/webhook_transaction_paid', [$this, 'handleTransactionPaid'], 10, 1);
808
- add_action('fluent_cart/payments/paddle/webhook_transaction_completed', [$this, 'handleTransactionCompleted'], 10, 1);
809
- add_action('fluent_cart/payments/paddle/webhook_transaction_payment_failed', [$this, 'handleTransactionPaymentFailed'], 10, 1);
810
-
811
- // Subscription lifecycle events
812
- add_action('fluent_cart/payments/paddle/webhook_subscription_created', [$this, 'handleSubscriptionActivated'], 10, 1);
813
- add_action('fluent_cart/payments/paddle/webhook_subscription_activated', [$this, 'handleSubscriptionActivated'], 10, 1);
814
- add_action('fluent_cart/payments/paddle/webhook_subscription_updated', [$this, 'handleSubscriptionUpdated'], 10, 1);
815
- add_action('fluent_cart/payments/paddle/webhook_subscription_canceled', [$this, 'handleSubscriptionCanceled'], 10, 1);
816
- add_action('fluent_cart/payments/paddle/webhook_subscription_paused', [$this, 'handleSubscriptionUpdated'], 10, 1);
817
- add_action('fluent_cart/payments/paddle/webhook_subscription_resumed', [$this, 'handleSubscriptionUpdated'], 10, 1);
818
- add_action('fluent_cart/payments/paddle/webhook_subscription_past_due', [$this, 'handleSubscriptionUpdated'], 10, 1);
819
- add_action('fluent_cart/payments/paddle/webhook_subscription_payment_received', [$this, 'handleSubscriptionPaymentReceived'], 10, 1);
820
-
821
- // Refund/adjustment events
822
- add_action('fluent_cart/payments/paddle/webhook_adjustment_created', [$this, 'handleAdjustmentCreated'], 10, 1);
823
- add_action('fluent_cart/payments/paddle/webhook_adjustment_updated', [$this, 'handleAdjustmentUpdated'], 10, 1);
824
- }
825
-
826
- /**
827
- * Main webhook entry point and processor
828
- */
829
- public function verifyAndProcess()
830
- {
831
- $rawPayload = file_get_contents('php://input');
832
- $payload = json_decode($rawPayload, true);
833
-
834
- if (!$payload) {
835
- $this->sendResponse(400, 'Invalid JSON payload');
836
- return;
837
- }
838
-
839
- // Verify webhook signature if not disabled
840
- if (!$this->settings->isWebhookVerificationDisabled()) {
841
- $webhookSecret = $this->settings->getWebhookSecret();
842
- if (empty($webhookSecret)) {
843
- error_log('Paddle Webhook Failed: Webhook secret not configured');
844
- $this->sendResponse(500, 'Webhook secret not configured');
845
- return;
846
- }
847
-
848
- $verifier = new WebhookVerifier($webhookSecret);
849
- $paddleSignature = $_SERVER['HTTP_PADDLE_SIGNATURE'];
850
-
851
- if (!$verifier->verify($paddleSignature, $rawPayload)) {
852
- error_log('Paddle Webhook Failed: Invalid webhook signature');
853
- $this->sendResponse(401, 'Invalid webhook signature');
854
- return;
855
- }
856
- }
857
-
858
- // Get order from webhook data
859
- $order = PaddleHelper::getOrderFromWebhookData($payload);
860
- if (!$order) {
861
- $this->sendResponse(200, 'Order not found');
862
- return;
863
- }
864
-
865
- $eventType = Arr::get($payload, 'event_type');
866
-
867
- // Validate accepted events
868
- $acceptedEvents = [
869
- 'transaction.paid', 'transaction.completed', 'transaction.payment_failed',
870
- 'adjustment.created', 'adjustment.updated',
871
- 'subscription.created', 'subscription.activated', 'subscription.updated',
872
- 'subscription.canceled', 'subscription.paused', 'subscription.resumed',
873
- 'subscription.past_due'
874
- ];
875
-
876
- if (!in_array($eventType, $acceptedEvents)) {
877
- $this->sendResponse(200, 'Event type not handled');
878
- return;
879
- }
880
-
881
- // Log webhook for debugging
882
- do_action('fluent_cart/paddle_webhook_received', [
883
- 'event_type' => $eventType,
884
- 'data' => $payload,
885
- 'raw' => $rawPayload,
886
- 'order' => $order
887
- ]);
888
-
889
- // Process specific webhook event
890
- $eventTypeFormatted = str_replace('.', '_', $eventType);
891
-
892
- // Handle subscription renewal detection
893
- if ($eventTypeFormatted === 'transaction_completed' || $eventTypeFormatted === 'transaction_paid') {
894
- $paddleTransaction = Arr::get($payload, 'data');
895
- $vendorSubscriptionId = Arr::get($paddleTransaction, 'subscription_id');
896
-
897
- if ($vendorSubscriptionId) {
898
- $eventTypeFormatted = 'subscription_payment_received';
899
- }
900
- }
901
-
902
- // Fire specific event handler
903
- if (has_action('fluent_cart/payments/paddle/webhook_' . $eventTypeFormatted)) {
904
- do_action('fluent_cart/payments/paddle/webhook_' . $eventTypeFormatted, [
905
- 'event_type' => $eventType,
906
- 'data' => $payload,
907
- 'raw' => $rawPayload,
908
- 'order' => $order
909
- ]);
910
-
911
- $this->sendResponse(200, 'Webhook processed successfully');
912
- } else {
913
- $this->sendResponse(200, 'No handler found for event type');
914
- }
915
- }
916
- }```
917
-
918
- ### Individual Event Handlers [](#individual-event-handlers)
919
-
920
- #### Payment Completion Handler [](#payment-completion-handler)
921
- php
922
- ```
923
- public function handleTransactionPaid($webhookData)
924
- {
925
- $payload = Arr::get($webhookData, 'data');
926
- $paddleTransaction = Arr::get($payload, 'data');
927
- $paddleTransactionId = Arr::get($paddleTransaction, 'id');
928
-
929
- // Extract custom data for correlation
930
- $customData = Arr::get($paddleTransaction, 'custom_data', []);
931
- $transactionHash = Arr::get($customData, 'fct_transaction_hash');
932
-
933
- // Find transaction by vendor ID or hash
934
- $transactionModel = OrderTransaction::query()->where('vendor_charge_id', $paddleTransactionId)->first();
935
-
936
- if (!$transactionModel && $transactionHash) {
937
- $transactionModel = OrderTransaction::query()->where('uuid', $transactionHash)->first();
938
- }
939
-
940
- if (!$transactionModel || $transactionModel->status === Status::TRANSACTION_SUCCEEDED) {
941
- return false;
942
- }
943
-
944
- // Use FluentCart's confirmation service
945
- (new Confirmations())->confirmPaymentSuccessByCharge($transactionModel, [
946
- 'vendor_charge_id' => $paddleTransactionId,
947
- 'charge' => $paddleTransaction
948
- ]);
949
-
950
- return true;
951
- }```
952
-
953
- #### Subscription Management Handler [](#subscription-management-handler)
954
- php
955
- ```
956
- public function handleSubscriptionActivated($webhookData)
957
- {
958
- $data = Arr::get($webhookData, 'data');
959
- $paddleSubscription = Arr::get($data, 'data');
960
- $order = Arr::get($webhookData, 'order');
961
-
962
- $customData = Arr::get($paddleSubscription, 'custom_data', []);
963
- $subscriptionHash = Arr::get($customData, 'fct_subscription_hash');
964
- $vendorSubscriptionId = Arr::get($paddleSubscription, 'id');
965
-
966
- // Find subscription by vendor ID or hash
967
- $subscription = Subscription::query()->where('vendor_subscription_id', $vendorSubscriptionId)->first();
968
-
969
- if (!$subscription) {
970
- $subscription = Subscription::query()->where('uuid', $subscriptionHash)->first();
971
- }
972
-
973
- if (!$subscription) {
974
- return false;
975
- }
976
-
977
- // Update subscription with complete data
978
- $billCount = OrderTransaction::query()->where('subscription_id', $subscription->id)->count();
979
- $updateData = [
980
- 'vendor_subscription_id' => Arr::get($paddleSubscription, 'id'),
981
- 'current_payment_method' => 'paddle',
982
- 'status' => PaddleHelper::transformSubscriptionStatus(Arr::get($paddleSubscription, 'status')),
983
- 'bill_count' => $billCount,
984
- 'next_billing_date' => gmdate('Y-m-d H:i:s', strtotime(Arr::get($paddleSubscription, 'next_billed_at'))),
985
- 'vendor_response' => json_encode($paddleSubscription)
986
- ];
987
-
988
- $oldStatus = $subscription->status;
989
- $subscription->update($updateData);
990
-
991
- // Fire subscription activated event for new subscriptions
992
- if (in_array($subscription->status, [Status::SUBSCRIPTION_ACTIVE, Status::SUBSCRIPTION_TRIALING])
993
- && !in_array($oldStatus, [Status::SUBSCRIPTION_ACTIVE, Status::SUBSCRIPTION_TRIALING])
994
- && $subscription->bill_count === 0) {
995
-
996
- (new SubscriptionActivated($subscription, $order, $order->customer))->dispatch();
997
- }
998
-
999
- return true;
1000
- }```
1001
-
1002
- #### Refund Processing Handler [](#refund-processing-handler)
1003
- php
1004
- ```
1005
- public function handleAdjustmentCreated($webhookData)
1006
- {
1007
- $payload = Arr::get($webhookData, 'data');
1008
- $paddleAdjustment = Arr::get($payload, 'data');
1009
- $paddleAdjustmentId = Arr::get($paddleAdjustment, 'id');
1010
- $action = Arr::get($paddleAdjustment, 'action');
1011
-
1012
- // Only handle refund adjustments
1013
- if ($action !== 'refund') {
1014
- return false;
1015
- }
1016
-
1017
- $parentTransactionId = Arr::get($paddleAdjustment, 'transaction_id');
1018
- $parentTransaction = OrderTransaction::query()->where('vendor_charge_id', $parentTransactionId)->first();
1019
-
1020
- if (!$parentTransaction) {
1021
- return false;
1022
- }
1023
-
1024
- // Calculate refund amount from adjustment items
1025
- $paddleRefundAmount = 0;
1026
- foreach (Arr::get($paddleAdjustment, 'items', []) as $item) {
1027
- $paddleRefundAmount += Arr::get($item, 'totals.total', 0);
1028
- }
1029
-
1030
- $status = $this->transformAdjustmentStatus(Arr::get($paddleAdjustment, 'status'));
1031
-
1032
- // Use FluentCart's refund service
1033
- return \FluentCart\App\Services\Payments\Refund::createOrRecordRefund([
1034
- 'vendor_charge_id' => $paddleAdjustmentId,
1035
- 'payment_method' => 'paddle',
1036
- 'payment_mode' => $parentTransaction->payment_mode, // Use stored order mode
1037
- 'status' => $status,
1038
- 'total' => $paddleRefundAmount,
1039
- ], $parentTransaction);
1040
- }
1041
-
1042
- public function handleAdjustmentUpdated($webhookData)
1043
- {
1044
- $payload = Arr::get($webhookData, 'data');
1045
- $paddleAdjustment = Arr::get($payload, 'data');
1046
- $paddleAdjustmentId = Arr::get($paddleAdjustment, 'id');
1047
-
1048
- $adjustmentTransaction = OrderTransaction::query()->where('vendor_charge_id', $paddleAdjustmentId)->first();
1049
-
1050
- if (!$adjustmentTransaction) {
1051
- return false;
1052
- }
1053
-
1054
- // Update refund status
1055
- $adjustmentTransaction->update([
1056
- 'status' => $this->transformAdjustmentStatus(Arr::get($paddleAdjustment, 'status'))
1057
- ]);
1058
-
1059
- // Fire refund event if completed
1060
- if ($adjustmentTransaction->status === Status::TRANSACTION_REFUNDED) {
1061
- (new OrderRefund($order, $adjustmentTransaction))->dispatch();
1062
- }
1063
-
1064
- return true;
1065
- }```
1066
-
1067
- #### Subscription Renewal Handler [](#subscription-renewal-handler)
1068
- php
1069
- ```
1070
- public function handleSubscriptionPaymentReceived($webhookData)
1071
- {
1072
- $order = Arr::get($webhookData, 'order');
1073
- $payload = Arr::get($webhookData, 'data');
1074
- $paddleSubscriptionId = Arr::get($payload, 'data.subscription_id');
1075
-
1076
- // Find subscription
1077
- $subscriptionModel = Subscription::query()->where('vendor_subscription_id', $paddleSubscriptionId)->first();
1078
-
1079
- if (!$subscriptionModel) {
1080
- $subscriptionModel = Subscription::query()->where('parent_order_id', $order->id)->first();
1081
- }
1082
-
1083
- if (!$subscriptionModel) {
1084
- return false;
1085
- }
1086
-
1087
- // Re-sync subscription data from remote
1088
- $subscriptionModel->reSyncFromRemote();
1089
-
1090
- return true;
1091
- }```
1092
-
1093
- **Key Insights:**
1094
-
1095
- - **Complete Event Coverage**: Handles all payment, subscription, and refund events
1096
- - **Smart Event Detection**: Automatically detects subscription renewals vs new payments
1097
- - **Service Method Integration**: Uses FluentCart's service methods instead of manual hook firing
1098
- - **Robust Error Handling**: Comprehensive validation and error responses
1099
- - **Data Correlation**: Uses custom data fields to correlate webhooks with local records
1100
- - **Status Management**: Proper status transformations and updates
1101
- - **Signature Verification**: Optional but recommended security verification
1102
- - **Logging Integration**: Uses FluentCart's action system for debugging
1103
-
1104
- ## Web Hook Implementation [](#web-hook-implementation)
1105
-
1106
- ### Signature Verification [](#signature-verification)
1107
- php
1108
- ```
1109
- public static function verifyWebhook($payload = null, $signature = null, $mode = '')
1110
- {
1111
- if ($payload === null) {
1112
- $payload = file_get_contents('php://input');
1113
- }
1114
-
1115
- if ($signature === null) {
1116
- $signature = $_SERVER['HTTP_PADDLE_SIGNATURE'] ?? '';
1117
- }
1118
-
1119
- return self::verifyWebhookSignature($payload, $signature, $mode);
1120
- }
1121
-
1122
- private static function verifyWebhookSignature($payload, $signature, $mode)
1123
- {
1124
- $settings = new PaddleSettings();
1125
- $secret = $settings->getWebhookSecret($mode);
1126
-
1127
- if (!$secret || !$signature) {
1128
- return false;
1129
- }
1130
-
1131
- // Paddle-specific signature verification logic
1132
- // This uses Paddle's signature format and algorithm
1133
- return hash_equals($expectedSignature, $signature);
1134
- }```
1135
-
1136
- **Key Insights:**
1137
-
1138
- - Flexible parameter handling (allows testing)
1139
- - Environment-aware secret selection
1140
- - Uses hash_equals for timing attack protection
1141
- - Gateway-specific signature algorithms
1142
-
1143
- ### Event Processing [](#event-processing)
1144
- php
1145
- ```
1146
- class IPN
1147
- {
1148
- public function init(): void
1149
- {
1150
- // Register webhook event handlers
1151
- add_action('fluent_cart/payments/paddle/webhook_transaction_paid', [$this, 'handleTransactionPaid'], 10, 1);
1152
- add_action('fluent_cart/payments/paddle/webhook_transaction_completed', [$this, 'handleTransactionCompleted'], 10, 1);
1153
- add_action('fluent_cart/payments/paddle/webhook_subscription_created', [$this, 'handleSubscriptionCreated'], 10, 1);
1154
- // ... more handlers
1155
- }
1156
-
1157
- public function verifyAndProcess(): void
1158
- {
1159
- $payload = file_get_contents('php://input');
1160
- $signature = $_SERVER['HTTP_PADDLE_SIGNATURE'] ?? '';
1161
-
1162
- if (!API::verifyWebhook($payload, $signature)) {
1163
- http_response_code(401);
1164
- exit('Unauthorized');
1165
- }
1166
-
1167
- $data = json_decode($payload, true);
1168
- $this->processWebhookEvent($data);
1169
-
1170
- http_response_code(200);
1171
- exit('OK');
1172
- }
1173
- }```
1174
-
1175
- **Key Insights:**
1176
-
1177
- - Uses WordPress action system for event handling
1178
- - Modular event processing
1179
- - Proper HTTP response codes
1180
- - Early exit after processing
1181
-
1182
- ## Complete Frontend Integration [](#complete-frontend-integration)
1183
-
1184
- ### Multi-Script Asset Management [](#multi-script-asset-management)
1185
- php
1186
- ```
1187
- public function getEnqueueScriptSrc($hasSubscription = 'no'): array
1188
- {
1189
- // Placeholder CDN host — point this at the gateway's published checkout SDK bundle.
1190
- $paddleJsUrl = 'https://cdn.example.com/paddle/v2/paddle.js';
1191
-
1192
- return [
1193
- [
1194
- 'handle' => 'fluent-cart-checkout-sdk-paddle-js',
1195
- 'src' => $paddleJsUrl,
1196
- ],
1197
- [
1198
- 'handle' => 'fluent-cart-paddle-checkout',
1199
- 'src' => Vite::getEnqueuePath('public/payment-methods/paddle-checkout.js'),
1200
- 'deps' => ['fluent-cart-checkout-sdk-paddle-js']
1201
- ]
1202
- ];
1203
- }
1204
-
1205
- public function getLocalizeData(): array
1206
- {
1207
- return [
1208
- 'fct_paddle_data' => [
1209
- 'translations' => [
1210
- 'Paddle SDK is not loaded. Please ensure the Paddle script is included.' => __('Paddle SDK is not loaded...', 'fluent-cart-pro'),
1211
- 'Paddle client token is missing or invalid.' => __('Paddle client token is missing or invalid.', 'fluent-cart-pro'),
1212
- 'Pay with Paddle' => __('Pay with Paddle', 'fluent-cart-pro'),
1213
- 'Secure payment powered by Paddle' => __('Secure payment powered by Paddle', 'fluent-cart-pro'),
1214
- 'Order creation failed' => __('Order creation failed', 'fluent-cart-pro'),
1215
- 'Failed to create order' => __('Failed to create order', 'fluent-cart-pro'),
1216
- 'No Paddle price IDs found in order data. Please ensure Paddle products are properly configured.' => __('No Paddle price IDs found...', 'fluent-cart-pro'),
1217
- 'Error: Missing transaction ID' => __('Error: Missing transaction ID', 'fluent-cart-pro'),
1218
- 'Payment failed' => __('Payment failed', 'fluent-cart-pro'),
1219
- 'An error occurred. Please try again.' => __('An error occurred. Please try again.', 'fluent-cart-pro'),
1220
- ]
1221
- ]
1222
- ];
1223
- }```
1224
-
1225
- ### Dynamic Order Information Handling [](#dynamic-order-information-handling)
1226
- php
1227
- ```
1228
- public function getOrderInfo(array $data)
1229
- {
1230
- $cart = CartHelper::getCart();
1231
- $checkOutHelper = new CartCheckoutHelper(true);
1232
- $shippingChargeData = (new WebCheckoutHandler())->getShippingChargeData($cart);
1233
- $shippingCharge = Arr::get($shippingChargeData, 'charge');
1234
- $totalPrice = $checkOutHelper->getItemsAmountTotal(false) + $shippingCharge;
1235
-
1236
- $items = $checkOutHelper->getItems();
1237
- $hasSubscription = $this->validateSubscriptions($items);
1238
-
1239
- $clientToken = $this->settings->getClientToken();
1240
- $settings = $this->settings->get();
1241
-
1242
- // Prepare frontend payment arguments
1243
- $paymentArgs = [
1244
- 'client_token' => $clientToken ?: '',
1245
- 'mode' => $this->settings->getMode(), // Current payment mode from settings
1246
- 'paddle_checkout_button_text' => Arr::get($settings, 'paddle_checkout_button_text', ''),
1247
- 'paddle_checkout_button_color' => Arr::get($settings, 'paddle_checkout_button_color', ''),
1248
- 'paddle_checkout_button_hover_color' => Arr::get($settings, 'paddle_checkout_button_hover_color', ''),
1249
- 'paddle_checkout_button_text_color' => Arr::get($settings, 'paddle_checkout_button_text_color', ''),
1250
- 'paddle_checkout_button_font_size' => Arr::get($settings, 'paddle_checkout_button_font_size', '')
1251
- ];
1252
-
1253
- // Prepare payment details
1254
- $paymentDetails = [
1255
- 'mode' => 'payment',
1256
- 'theme' => Arr::get($settings, 'paddle_checkout_theme', 'light'),
1257
- 'amount' => Helper::toDecimalWithoutComma($totalPrice),
1258
- 'currency' => strtoupper(CurrencySettings::get('currency')),
1259
- 'locale' => (new StoreSettings())->get('locale', 'en'),
1260
- ];
1261
-
1262
- if ($hasSubscription) {
1263
- $paymentDetails['mode'] = 'subscription';
1264
- }
1265
-
1266
- $this->checkCurrencySupport();
1267
-
1268
- wp_send_json([
1269
- 'status' => 'success',
1270
- 'payment_args' => $paymentArgs,
1271
- 'intent' => $paymentDetails,
1272
- 'has_subscription' => $hasSubscription,
1273
- 'message' => __('Order info retrieved!', 'fluent-cart-pro')
1274
- ], 200);
1275
- }```
1276
-
1277
- **Key Insights:**
1278
-
1279
- - **Dynamic Asset Loading**: External SDK + custom integration scripts
1280
-
1281
- ### Paddle Checkout JavaScript Implementation [](#paddle-checkout-javascript-implementation)
1282
-
1283
- The frontend JavaScript implementation handles the customer checkout experience:javascript
1284
- ```
1285
- // File: resources/public/payment-methods/paddle-checkout.js
1286
- class PaddleCheckout {
1287
- constructor(form, orderHandler, response, paymentLoader) {
1288
- this.form = form;
1289
- this.orderHandler = orderHandler;
1290
- this.data = response;
1291
- this.paymentArgs = response?.payment_args || {};
1292
- this.intent = response?.intent || {};
1293
- this.paymentLoader = paymentLoader;
1294
- this.currentOrderData = null;
1295
- this.$t = this.translate.bind(this);
1296
- }
1297
-
1298
- translate(string) {
1299
- const translations = window.fct_paddle_data?.translations || {};
1300
- return translations[string] || string;
1301
- }
1302
-
1303
- init() {
1304
- const paddleButtonContainer = document.querySelector('.fluent-cart-checkout_embed_payment_container_paddle');
1305
- if (!paddleButtonContainer) {
1306
- console.error('Paddle container not found');
1307
- return;
1308
- }
1309
-
1310
- // Clear any existing content
1311
- paddleButtonContainer.innerHTML = '';
1312
-
1313
- // Initialize Paddle SDK and create button
1314
- this.initializePaddleSDK()
1315
- .then(() => {
1316
- this.createPaddleButton(paddleButtonContainer);
1317
- })
1318
- .catch((error) => {
1319
- console.error('Paddle initialization error:', error);
1320
- this.displayErrorMessage(paddleButtonContainer, error.message);
1321
- });
1322
- }
1323
-
1324
- async initializePaddleSDK() {
1325
- if (typeof Paddle === 'undefined') {
1326
- throw new Error(this.$t('Paddle SDK is not loaded. Please ensure the Paddle script is included.'));
1327
- }
1328
-
1329
- const clientToken = this.paymentArgs?.client_token;
1330
- const environment = this.paymentArgs?.mode === 'test' ? 'sandbox' : 'production';
1331
-
1332
- if (!clientToken) {
1333
- throw new Error(this.$t('Paddle client token is missing or invalid.'));
1334
- }
1335
-
1336
- Paddle.Environment.set(environment);
1337
- Paddle.Initialize({
1338
- token: clientToken.trim(),
1339
- eventCallback: (data) => {
1340
- this.handlePaddleEvent(data);
1341
- }
1342
- });
1343
- }
1344
-
1345
- createPaddleButton(container) {
1346
- const paddleButton = document.createElement('button');
1347
- paddleButton.id = 'paddle-pay-button';
1348
- paddleButton.className = 'paddle-checkout-button';
1349
- paddleButton.innerHTML = this.$t('Pay with Paddle');
1350
- paddleButton.style.cssText = `
1351
- width: 100%;
1352
- padding: 12px 24px;
1353
- background: #1a73e8;
1354
- color: #fff;
1355
- border: none;
1356
- border-radius: 6px;
1357
- font-weight: 500;
1358
- cursor: pointer;
1359
- `;
1360
-
1361
- paddleButton.addEventListener('click', async (e) => {
1362
- e.preventDefault();
1363
- await this.handlePaddleButtonClick();
1364
- });
1365
-
1366
- container.appendChild(paddleButton);
1367
- }
1368
-
1369
- async handlePaddleButtonClick() {
1370
- try {
1371
- this.paymentLoader?.changeLoaderStatus('processing');
1372
-
1373
- if (typeof this.orderHandler === 'function') {
1374
- const orderData = await this.orderHandler();
1375
- if (!orderData) {
1376
- throw new Error(this.$t('Failed to create order'));
1377
- }
1378
-
1379
- // Open Paddle overlay checkout
1380
- await this.openPaddleOverlay(orderData);
1381
- } else {
1382
- throw new Error(this.$t('Order handler is not properly configured'));
1383
- }
1384
- } catch (error) {
1385
- this.paymentLoader?.changeLoaderStatus('Error: ' + error.message);
1386
- this.displayErrorMessage(
1387
- document.querySelector('.fluent-cart-checkout_embed_payment_container_paddle'),
1388
- error.message
1389
- );
1390
- }
1391
- }
1392
-
1393
- async openPaddleOverlay(orderData) {
1394
- this.currentOrderData = orderData;
1395
-
1396
- const paddleData = orderData?.response || orderData;
1397
- const items = paddleData?.paddle_price_ids?.map(item => ({
1398
- priceId: item.price_id,
1399
- quantity: parseInt(item.quantity) || 1
1400
- }));
1401
-
1402
- if (!items || items.length === 0) {
1403
- throw new Error(this.$t('No Paddle price IDs found in order data'));
1404
- }
1405
-
1406
- Paddle.Checkout.open({
1407
- settings: {
1408
- displayMode: 'overlay',
1409
- theme: this.intent?.theme || 'light',
1410
- locale: this.intent?.locale || 'en'
1411
- },
1412
- items: items,
1413
- customData: {
1414
- fct_order_hash: orderData?.data?.order?.hash || '',
1415
- fct_transaction_hash: orderData?.data?.transaction?.hash || '',
1416
- }
1417
- });
1418
- }
1419
-
1420
- handlePaddleEvent(eventData) {
1421
- switch (eventData.name) {
1422
- case 'checkout.completed':
1423
- this.handlePaddlePaymentSuccess(eventData.data);
1424
- break;
1425
- case 'checkout.closed':
1426
- this.handlePaddleCheckoutClosed(eventData.data);
1427
- break;
1428
- case 'checkout.payment.failed':
1429
- this.handlePaddlePaymentFailed(eventData.data);
1430
- break;
1431
- case 'checkout.error':
1432
- this.handlePaddleError(eventData.data);
1433
- break;
1434
- }
1435
- }
1436
-
1437
- async handlePaddlePaymentSuccess(paddleData) {
1438
- try {
1439
- this.paymentLoader?.changeLoaderStatus('confirming');
1440
- const transactionId = paddleData?.transaction_id;
1441
-
1442
- if (!transactionId) {
1443
- this.paymentLoader?.changeLoaderStatus(this.$t('Error: Missing transaction ID'));
1444
- return;
1445
- }
1446
-
1447
- const customData = paddleData.custom_data;
1448
- const confirmResponse = await this.confirmPayment(transactionId, customData);
1449
-
1450
- if (confirmResponse?.redirect_url) {
1451
- this.paymentLoader?.changeLoaderStatus('redirecting');
1452
- window.location.href = confirmResponse.redirect_url;
1453
- }
1454
- } catch (error) {
1455
- this.paymentLoader?.changeLoaderStatus('Error: ' + error.message);
1456
- }
1457
- }
1458
-
1459
- displayErrorMessage(container, message) {
1460
- const errorDiv = document.createElement('div');
1461
- errorDiv.style.color = 'red';
1462
- errorDiv.textContent = message;
1463
- container.appendChild(errorDiv);
1464
- }
1465
- }
1466
-
1467
- // Initialize when FluentCart triggers the event
1468
- window.addEventListener("fluent_cart_load_payments_paddle", function (e) {
1469
- // Request the gateway payment session from FluentCart's payment info endpoint
1470
- var request = new XMLHttpRequest();
1471
- request.open("POST", e.detail.paymentInfoUrl, true);
1472
- request.setRequestHeader("Content-Type", "application/json");
1473
- request.setRequestHeader("X-WP-Nonce", e.detail.nonce);
1474
- request.withCredentials = true;
1475
-
1476
- request.onload = function () {
1477
- var payload = JSON.parse(request.responseText);
1478
- new PaddleCheckout(e.detail.form, e.detail.orderHandler, payload, e.detail.paymentLoader).init();
1479
- };
1480
-
1481
- request.onerror = function () {
1482
- console.error('Failed to load Paddle payment info:', request.statusText);
1483
- };
1484
-
1485
- request.send();
1486
- });```
1487
-
1488
- - **Comprehensive Localization**: All user-facing messages translated
1489
- - **Real-time Order Processing**: Cart data processed on-demand
1490
- - **Subscription Detection**: Automatic mode switching based on cart contents
1491
- - **UI Customization**: Extensive theming and styling options
1492
- - **Currency Validation**: Pre-flight currency support checking
1493
-
1494
- ## Advanced Production Features [](#advanced-production-features)
1495
-
1496
- ### Comprehensive Settings with Dynamic Instructions [](#comprehensive-settings-with-dynamic-instructions)
1497
- php
1498
- ```
1499
- public function fields(): array
1500
- {
1501
- $webhookInstructions = $this->getWebhookInstructions();
1502
-
1503
- $testSchema = [
1504
- 'test_api_key' => array(
1505
- 'value' => '',
1506
- 'label' => __('Sandbox API Key', 'fluent-cart-pro'),
1507
- 'type' => 'password',
1508
- 'placeholder' => __('Your sandbox API key', 'fluent-cart-pro'),
1509
- 'help_text' => __('Get your API key from Paddle Dashboard > Developer Tools > Authentication', 'fluent-cart-pro')
1510
- ),
1511
- 'test_client_token' => array(
1512
- 'value' => '',
1513
- 'label' => __('Sandbox Client Token / Public Key', 'fluent-cart-pro'),
1514
- 'type' => 'text',
1515
- 'placeholder' => __('Your sandbox client token', 'fluent-cart-pro'),
1516
- 'help_text' => __('Optional: Used for frontend checkout integration', 'fluent-cart-pro')
1517
- ),
1518
- 'test_webhook_secret' => array(
1519
- 'value' => '',
1520
- 'label' => __('Sandbox Webhook Secret', 'fluent-cart-pro'),
1521
- 'type' => 'password',
1522
- 'placeholder' => __('Your sandbox webhook secret', 'fluent-cart-pro'),
1523
- 'help_text' => __('Used to verify webhook signatures', 'fluent-cart-pro')
1524
- ),
1525
- 'test_webhook_desc' => array(
1526
- 'value' => $webhookInstructions,
1527
- 'label' => __('Webhook Configuration', 'fluent-cart-pro'),
1528
- 'type' => 'html_attr'
1529
- ),
1530
- ];
1531
-
1532
- // Live schema similar structure...
1533
-
1534
- return array(
1535
- 'notice' => [
1536
- 'value' => $this->renderStoreModeNotice(),
1537
- 'label' => __('Store Mode notice', 'fluent-cart-pro'),
1538
- 'type' => 'notice'
1539
- ],
1540
- 'beta_notice' => [
1541
- 'value' => '<p class="text-gray-500">Paddle payment gateway is currently in beta. Please use with caution!</p>',
1542
- 'label' => __('Beta Notice', 'fluent-cart-pro'),
1543
- 'type' => 'html_attr'
1544
- ],
1545
- 'payment_mode' => [
1546
- 'type' => 'tabs',
1547
- 'schema' => [
1548
- [
1549
- 'type' => 'tab',
1550
- 'label' => __('Live credentials', 'fluent-cart-pro'),
1551
- 'value' => 'live',
1552
- 'schema' => $liveSchema
1553
- ],
1554
- [
1555
- 'type' => 'tab',
1556
- 'label' => __('Test credentials', 'fluent-cart-pro'),
1557
- 'value' => 'test',
1558
- 'schema' => $testSchema
1559
- ]
1560
- ]
1561
- ],
1562
- 'paddle_checkout_theme' => [
1563
- 'value' => 'light',
1564
- 'label' => __('Paddle Checkout Theme', 'fluent-cart-pro'),
1565
- 'type' => 'select',
1566
- 'options' => [
1567
- 'light' => ['label' => __('Light', 'fluent-cart-pro'), 'value' => 'light'],
1568
- 'dark' => ['label' => __('Dark', 'fluent-cart-pro'), 'value' => 'dark']
1569
- ],
1570
- 'tooltip' => __('Theme to use for Paddle checkout modal', 'fluent-cart-pro')
1571
- ],
1572
- 'paddle_checkout_button_text' => [
1573
- 'value' => __('Pay with Paddle', 'fluent-cart-pro'),
1574
- 'label' => __('Paddle Checkout Button Text', 'fluent-cart-pro'),
1575
- 'type' => 'text',
1576
- 'placeholder' => __('Pay with Paddle', 'fluent-cart-pro'),
1577
- 'tooltip' => __('Text to display on the Paddle checkout button', 'fluent-cart-pro')
1578
- ],
1579
- 'paddle_checkout_button_color' => [
1580
- 'value' => '',
1581
- 'label' => __('Paddle Checkout Button Color', 'fluent-cart-pro'),
1582
- 'type' => 'color',
1583
- 'tooltip' => __('Color of the Paddle checkout button', 'fluent-cart-pro')
1584
- ],
1585
- 'disable_webhook_verification' => [
1586
- 'value' => 'no',
1587
- 'label' => __('Disable Webhook Verification', 'fluent-cart-pro'),
1588
- 'type' => 'checkbox',
1589
- 'tooltip' => __('Only disable this for testing purposes. Keep enabled for production.', 'fluent-cart-pro')
1590
- ]
1591
- );
1592
- }
1593
-
1594
- public function getWebhookInstructions()
1595
- {
1596
- $webhook_url = $this->getWebhookUrl();
1597
- $eventsHtml = $this->getEventshtml();
1598
-
1599
- // Dynamic HTML instructions based on configuration state
1600
- $instructionsHtml =
1601
- '<div class="paddle-webhook-instructions" style="padding:12px 0;">'
1602
- . '<p><strong>' . esc_html__('Webhook URL:', 'fluent-cart-pro') . '</strong> '
1603
- . '<code class="copyable-content" data-copy="' . esc_attr($webhook_url) . '">' . esc_html($webhook_url) . '</code></p>'
1604
- . '<p>' . esc_html__('You should configure your Paddle webhooks to get all updates of your payments remotely.', 'fluent-cart-pro') . '</p>'
1605
- . '<p>' . esc_html__('Select the following events:', 'fluent-cart-pro') . '</p>'
1606
- . '<p style="display:flex; align-items:center; flex-wrap:wrap; gap:8px 4px;">' . wp_kses_post($eventsHtml) . '</p>'
1607
- . '</div>';
1608
-
1609
- return $instructionsHtml;
1610
- }```
1611
-
1612
- ### Multi-Environment Support with Security [](#multi-environment-support-with-security)
1613
- php
1614
- ```
1615
- public static function beforeSettingsUpdate($data, $oldSettings): array
1616
- {
1617
- $mode = Arr::get($data, 'payment_mode', 'live');
1618
- $apiKeyField = $mode . '_api_key';
1619
-
1620
- // Encrypt sensitive data before storage
1621
- $data[$apiKeyField] = Helper::encryptKey($data[$apiKeyField]);
1622
-
1623
- return $data;
1624
- }
1625
-
1626
- public static function validateSettings($data): array
1627
- {
1628
- $mode = Arr::get($data, 'payment_mode', 'live');
1629
- $apiKey = Arr::get($data, $mode . '_api_key');
1630
-
1631
- if (empty($apiKey)) {
1632
- return [
1633
- 'status' => 'failed',
1634
- 'message' => __('API key is required.', 'fluent-cart-pro')
1635
- ];
1636
- }
1637
-
1638
- // Could add live API connectivity test here
1639
- // $testResponse = API::testConnection($apiKey, $mode);
1640
-
1641
- return [
1642
- 'status' => 'success',
1643
- 'message' => __('Paddle gateway credentials verified successfully!', 'fluent-cart-pro')
1644
- ];
1645
- }```
1646
-
1647
- ### Currency and Transaction URL Management [](#currency-and-transaction-url-management)
1648
- php
1649
- ```
1650
- public function isCurrencySupported(): bool
1651
- {
1652
- $supportedCurrencies = [
1653
- 'USD', 'EUR', 'GBP', 'JPY', 'AUD', 'CAD', 'CHF', 'HKD', 'SGD', 'SEK',
1654
- 'ARS', 'BRL', 'CNY', 'COP', 'CZK', 'DKK', 'HUF', 'ILS', 'INR', 'KRW',
1655
- 'MXN', 'NOK', 'NZD', 'PLN', 'RUB', 'THB', 'TRY', 'TWD', 'UAH', 'VND', 'ZAR'
1656
- ];
1657
-
1658
- return in_array(strtoupper(CurrencySettings::get('currency')), $supportedCurrencies);
1659
- }
1660
-
1661
- public function getTransactionUrl($url, $data)
1662
- {
1663
- if (Arr::get($data, 'transaction_type') === 'refund') {
1664
- $parentTransaction = OrderTransaction::query()->where('id', Arr::get($data, 'transaction.meta.parent_id'))->first();
1665
- $data['vendor_charge_id'] = $parentTransaction->vendor_charge_id;
1666
- }
1667
-
1668
- // Use payment_mode from transaction data (stored order mode at checkout time)
1669
- if (Arr::get($data, 'payment_mode') === 'test') {
1670
- return 'https://sandbox-vendors.example.com/transactions-v2/' . Arr::get($data, 'vendor_charge_id');
1671
- }
1672
-
1673
- return 'https://vendors.example.com/transactions-v2/' . Arr::get($data, 'vendor_charge_id');
1674
- }
1675
-
1676
- public function getSubscriptionUrl($url, $data)
1677
- {
1678
- // Use payment_mode from subscription data (stored order mode at checkout time)
1679
- if (Arr::get($data, 'payment_mode') === 'test') {
1680
- return 'https://sandbox-vendors.example.com/subscriptions-v2/' . Arr::get($data, 'vendor_subscription_id');
1681
- }
1682
-
1683
- return 'https://vendors.example.com/subscriptions-v2/' . Arr::get($data, 'vendor_subscription_id');
1684
- }```
1685
-
1686
- ### Success and Cancel URL Handling [](#success-and-cancel-url-handling)
1687
- php
1688
- ```
1689
- public function getSuccessUrl($transaction, $args = [])
1690
- {
1691
- $paymentHelper = new PaymentHelper($this->getMeta('route'));
1692
- return $paymentHelper->successUrl($transaction->uuid, $args);
1693
- }
1694
-
1695
- public static function getCancelUrl(): string
1696
- {
1697
- $checkoutPage = (new StoreSettings())->getCheckoutPage();
1698
- $cartHash = $_GET['fct_cart_hash'] ?? '';
1699
-
1700
- if ($cartHash) {
1701
- return add_query_arg([
1702
- 'fct_cart_hash' => $cartHash
1703
- ], $checkoutPage);
1704
- }
1705
-
1706
- return $checkoutPage;
1707
- }```
1708
-
1709
- **Key Insights:**
1710
-
1711
- - **Dynamic Configuration**: Settings UI changes based on configuration state
1712
- - **Security-First Approach**: API key encryption and secure storage
1713
- - **Environment Awareness**: All URLs and endpoints environment-specific
1714
- - **Comprehensive Validation**: Settings validation with optional API testing
1715
- - **User Experience**: Helpful instructions and copyable content
1716
- - **Production-Ready**: Extensive customization options for branding
1717
- - **URL Management**: Proper success/cancel URL handling with cart state preservation
1718
-
1719
- ## Registration Pattern [](#registration-pattern)
1720
- php
1721
- ```
1722
- public static function register()
1723
- {
1724
- fluent_cart_api()->registerCustomPaymentMethod('paddle', new self());
1725
- }```
1726
-
1727
- **Key Insights:**
1728
-
1729
- - Simple static registration method
1730
- - Self-instantiation pattern
1731
- - Called from bootstrap file
1732
-
1733
- ## Comprehensive Lessons Learned [](#comprehensive-lessons-learned)
1734
-
1735
- ### 1. **Complete Payment Lifecycle Management** [](#_1-complete-payment-lifecycle-management)
1736
-
1737
- - **One-time Payments**: Full transaction flow from creation to confirmation
1738
- - **Subscription Payments**: Complex billing cycles, trials, and renewal handling
1739
- - **Refund Processing**: Comprehensive adjustment and refund management
1740
- - **Status Synchronization**: Real-time status updates via webhooks
1741
-
1742
- ### 2. **Three-Layer Webhook Architecture** [](#_2-three-layer-webhook-architecture)
1743
-
1744
- - **Entry Point**: Single `handleIPN()` method for all webhook traffic
1745
- - **Central Processor**: `verifyAndProcess()` with signature verification and routing
1746
- - **Event Handlers**: Specific handlers for each event type using FluentCart services
1747
- - **Error Handling**: Comprehensive HTTP response codes and logging
1748
-
1749
- ### 3. **Service Method Integration** [](#_3-service-method-integration)
1750
-
1751
- - **StatusHelper**: Automatic order status sync and hook firing
1752
- - **Refund Service**: Complete refund transaction management
1753
- - **SubscriptionService**: Subscription lifecycle and renewal processing
1754
- - **Confirmation Service**: Payment confirmation with complex data handling
1755
-
1756
- ### 4. **Production-Ready Security** [](#_4-production-ready-security)
1757
-
1758
- - **Signature Verification**: Optional but recommended webhook signature validation
1759
- - **API Key Encryption**: Secure storage of sensitive credentials
1760
- - **Environment Separation**: Complete test/live mode isolation
1761
- - **Input Validation**: Comprehensive data validation and sanitization
1762
-
1763
- ### 5. **Advanced Settings Architecture** [](#_5-advanced-settings-architecture)
1764
-
1765
- - **Dynamic Configuration**: UI that changes based on current settings
1766
- - **Tabbed Interface**: Clean separation of test/live credentials
1767
- - **Visual Customization**: Extensive theming and branding options
1768
- - **Helpful Instructions**: Dynamic webhook setup guidance
1769
-
1770
- ### 6. **Frontend Integration Excellence** [](#_6-frontend-integration-excellence)
1771
-
1772
- - **Multi-Script Loading**: External SDK + custom integration scripts
1773
- - **Comprehensive Localization**: All user-facing messages translated
1774
- - **Real-time Processing**: Dynamic order and cart processing
1775
- - **UI Customization**: Extensive checkout appearance options
1776
-
1777
- ### 7. **Subscription Management Complexity** [](#_7-subscription-management-complexity)
1778
-
1779
- - **Billing Cycle Mapping**: Complex interval and frequency handling
1780
- - **Trial Period Support**: Scheduled activation after trial periods
1781
- - **Renewal Detection**: Smart detection of subscription vs one-time payments
1782
- - **Status Transformation**: Gateway-specific to FluentCart status mapping
1783
-
1784
- ### 8. **Data Architecture Patterns** [](#_8-data-architecture-patterns)
1785
-
1786
- - **Custom Data Fields**: Webhook correlation via custom metadata
1787
- - **Comprehensive Storage**: Full gateway response storage for debugging
1788
- - **Status Mapping**: Bidirectional status transformation
1789
- - **Transaction Relationships**: Parent-child relationships for refunds
1790
-
1791
- ## Application to Your Gateway Development [](#application-to-your-gateway-development)
1792
-
1793
- ### Essential Implementation Patterns [](#essential-implementation-patterns)
1794
-
1795
- -
1796
- **Gateway Class Structure**php
1797
- ```
1798
- // Complete feature declaration
1799
- public array $supportedFeatures = ['payment', 'refund', 'webhook', 'subscriptions'];
1800
-
1801
- // Composition over inheritance
1802
- public function __construct() {
1803
- parent::__construct(new YourSettings(), new YourSubscriptions());
1804
- }```
1805
-
1806
- -
1807
- **Payment Processing Delegation**php
1808
- ```
1809
- // Clean separation of concerns
1810
- public function makePaymentFromPaymentInstance(PaymentInstance $instance) {
1811
- if ($instance->subscription) {
1812
- return (new Processor())->handleSubscriptionPayment($instance);
1813
- }
1814
- return (new Processor())->handleSinglePayment($instance);
1815
- }```
1816
-
1817
- -
1818
- **Webhook Architecture Implementation**php
1819
- ```
1820
- // Three-layer pattern
1821
- public function handleIPN() { $this->verifyAndProcess(); }
1822
- private function verifyAndProcess() { /* verification + routing */ }
1823
- public function handleSpecificEvent($data) { /* use service methods */ }```
1824
-
1825
- -
1826
- **Service Method Usage**php
1827
- ```
1828
- // Use FluentCart services instead of manual hooks
1829
- (new StatusHelper($order))->syncOrderStatuses($transaction);
1830
- Refund::createOrRecordRefund([...], $parentTransaction);
1831
- SubscriptionService::recordManualRenewal($subscription, $transaction, $args);```
1832
-
1833
- -
1834
- **Environment-Aware Configuration**php
1835
- ```
1836
- // Dynamic configuration based on mode
1837
- public function getApiKey($mode = '') {
1838
- if (!$mode) $mode = $this->getMode(); // Gets payment mode from settings
1839
- return $this->get($mode . '_api_key');
1840
- }
1841
-
1842
- // API calls should use order mode for consistency
1843
- API::createTransaction($data, $order->mode); // Use order's mode```
1844
-
1845
- -
1846
- **Mode Management Best Practices**php
1847
- ```
1848
- // ✅ Correct: Store order mode with transaction
1849
- $transaction->update(['payment_mode' => $order->mode]);
1850
-
1851
- // ✅ Correct: Always explicitly pass mode to API calls
1852
- API::createTransaction($data, $order->mode);
1853
- API::refundTransaction($transactionId, $order->mode);
1854
-
1855
- // ✅ Correct: Use payment mode for settings
1856
- $apiKey = $this->settings->getApiKey($this->settings->getMode());
1857
-
1858
- // ⚠️ Works but not recommended: Relying on fallback
1859
- API::createTransaction($data); // Falls back to settings mode
1860
-
1861
- // ❌ Wrong: Don't mix up the modes
1862
- $transaction->update(['payment_mode' => $this->settings->getMode()]);```
1863
-
1864
- ### Critical Success Factors [](#critical-success-factors)
1865
-
1866
- - **Use FluentCart's Service Layer**: Never manually fire hooks - use service methods
1867
- - **Implement Complete Webhook Handling**: Cover all payment lifecycle events
1868
- - **Understand Mode Management**: Use `$order->mode` for API calls, `$this->settings->getMode()` for configuration
1869
- - **Always Pass Mode Explicitly**: Don't rely on fallbacks - explicitly pass mode to all API calls
1870
- - **Plan for Subscriptions**: Even if not initial scope, design architecture to support them
1871
- - **Security First**: Implement signature verification and secure credential storage
1872
- - **Environment Awareness**: Support test/live modes throughout the entire implementation
1873
- - **Comprehensive Error Handling**: Proper HTTP responses, logging, and user feedback
1874
- - **Frontend Integration**: Plan for JavaScript SDK integration and UI customization
1875
- - **Production Considerations**: Currency support, URL management, transaction linking
1876
-
1877
- ### Architecture Decisions Framework [](#architecture-decisions-framework)
1878
-
1879
- - **Composition over Inheritance**: Separate settings, subscriptions, and processing classes
1880
- - **Service Layer Integration**: Use FluentCart's built-in services for all core operations
1881
- - **Event-Driven Webhooks**: Use WordPress actions for flexible webhook event handling
1882
- - **Environment Separation**: Complete isolation between test and live configurations
1883
- - **Security by Default**: Implement all security measures from the start
1884
- - **Extensible Design**: Plan for future features like subscriptions and advanced options
1885
-
1886
- This comprehensive case study demonstrates that a complete payment gateway implementation requires careful attention to **payment lifecycles**, **webhook architecture**, **service integration**, **security**, and **user experience** - all working together in a cohesive, production-ready system.
1887
- ## Application to Your Gateway [](#application-to-your-gateway)
1888
-
1889
- ### Code Patterns to Adopt [](#code-patterns-to-adopt)
1890
-
1891
- -
1892
- **Settings Structure**php
1893
- ```
1894
- // Environment-aware getters
1895
- public function getApiKey($mode = '') {
1896
- if (!$mode) $mode = $this->getMode();
1897
- return $this->get($mode . '_api_key');
1898
- }```
1899
-
1900
- -
1901
- **Error Handling**php
1902
- ```
1903
- // Consistent error responses
1904
- if (is_wp_error($response)) {
1905
- return new \WP_Error('gateway_error', $response->get_error_message());
1906
- }```
1907
-
1908
- -
1909
- **Web Hook Verification**php
1910
- ```
1911
- // Always verify webhooks
1912
- if (!$this->verifyWebhookSignature($payload, $signature)) {
1913
- http_response_code(401);
1914
- exit('Unauthorized');
1915
- }```
1916
-
1917
- -
1918
- **Feature Detection**php
1919
- ```
1920
- // Declare supported features clearly
1921
- public array $supportedFeatures = ['payment', 'refund', 'subscriptions', 'webhook'];```
1922
-
1923
- ### Architecture Decisions [](#architecture-decisions)
1924
-
1925
- - **Use composition over inheritance** for complex functionality
1926
- - **Separate API communication** into dedicated classes
1927
- - **Implement proper validation** at the settings level
1928
- - **Plan for localization** from the start
1929
- - **Design for testability** with dependency injection
1930
-
1931
- **Next:** [Get Started](https://dev.fluentcart.com/payment-methods-integration/index.html) integrating custom payment gateways with FluentCart.