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.
- package/dist/cards/fluentcart/tools.d.ts.map +1 -1
- package/dist/cards/fluentcart/tools.js +2368 -2323
- package/dist/cards/fluentcart/tools.js.map +1 -1
- package/dist/paths.d.ts +1 -1
- package/dist/paths.d.ts.map +1 -1
- package/dist/paths.js +1 -1
- package/dist/paths.js.map +1 -1
- package/dist/reference-reader.d.ts +32 -1
- package/dist/reference-reader.d.ts.map +1 -1
- package/dist/reference-reader.js +111 -22
- package/dist/reference-reader.js.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +8 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +66 -538
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
- package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
- package/dist/skills/fluentcart-developer/references/index.md +625 -0
- package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
- package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
- package/dist/skills/fluentcart-developer/.mcp.json +0 -11
- package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
- package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
- package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
- package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
- package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
- package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
- package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
- package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
- package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
- package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
- package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
- package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
- package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
- package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
- package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
- package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
- package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
- package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
- package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
- package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
- package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
- package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
- package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
- package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
- package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
- package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
- package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
- package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
- package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
- package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
- package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
- package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
- package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
- package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
- package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
- package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
- package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
- package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
- package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
- package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
- package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
- package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
- package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
- package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
- package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
- package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
- package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
|
@@ -1,938 +0,0 @@
|
|
|
1
|
-
# Subscriptions API
|
|
2
|
-
|
|
3
|
-
Manage recurring subscriptions including listing, cancellation, reactivation, payment method updates, and customer self-service operations.
|
|
4
|
-
|
|
5
|
-
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
|
|
6
|
-
|
|
7
|
-
> All monetary values are in cents (e.g., `$10.00` = `1000`).
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Endpoints Overview
|
|
12
|
-
|
|
13
|
-
### Admin Endpoints
|
|
14
|
-
|
|
15
|
-
| Method | Endpoint | Description |
|
|
16
|
-
|--------|----------|-------------|
|
|
17
|
-
| GET | `/subscriptions` | List Subscriptions |
|
|
18
|
-
| GET | `/subscriptions/{subscriptionOrderId}` | Get Subscription Details |
|
|
19
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/cancel` | Cancel Subscription |
|
|
20
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/fetch` | Fetch Subscription from Remote |
|
|
21
|
-
| POST | `/orders/{order}/subscriptions/{subscription}/early-payment-link` | Generate Early Payment Link |
|
|
22
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/reactivate` | Reactivate Subscription (Reserved) |
|
|
23
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/pause` | Pause Subscription (Reserved) |
|
|
24
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/resume` | Resume Subscription (Reserved) |
|
|
25
|
-
| POST | `/orders/{order}/subscriptions/{subscription}/charge-now` | Charge Subscription Now |
|
|
26
|
-
| POST | `/orders/{order}/subscriptions/{subscription}/create-renewal` | Create Renewal Now |
|
|
27
|
-
| POST | `/orders/{order}/subscriptions/{subscription}/skip-renewal` | Skip Next Renewal Period |
|
|
28
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/update` | Update Subscription |
|
|
29
|
-
| PUT | `/orders/{order}/subscriptions/{subscription}/vendor-ids` | Update Vendor IDs |
|
|
30
|
-
| POST | `/orders/{order}/subscriptions/{subscription}/verify-vendor-ids` | Verify Vendor IDs |
|
|
31
|
-
|
|
32
|
-
### Renewal Invoices
|
|
33
|
-
|
|
34
|
-
| Method | Endpoint | Description |
|
|
35
|
-
|--------|----------|-------------|
|
|
36
|
-
| GET | `/renewals` | List Renewal Invoices |
|
|
37
|
-
| GET | `/renewals/{id}` | Get Renewal Invoice Details |
|
|
38
|
-
| POST | `/renewals/{order}/resend` | Resend Renewal Invoice Email |
|
|
39
|
-
| POST | `/renewals/{order}/void` | Void Renewal Invoice |
|
|
40
|
-
|
|
41
|
-
### Customer Portal Endpoints
|
|
42
|
-
|
|
43
|
-
| Method | Endpoint | Description |
|
|
44
|
-
|--------|----------|-------------|
|
|
45
|
-
| GET | `/customer-profile/subscriptions` | List Customer Subscriptions |
|
|
46
|
-
| GET | `/customer-profile/subscriptions/{subscription_uuid}` | Get Customer Subscription Details |
|
|
47
|
-
| GET | `/customer-profile/subscriptions/{subscription_uuid}/setup-intent-attempts` | Get Setup Intent Attempts |
|
|
48
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/update-payment-method` | Update Payment Method |
|
|
49
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/get-or-create-plan` | Get or Create Plan |
|
|
50
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/switch-payment-method` | Switch Payment Method |
|
|
51
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/confirm-subscription-switch` | Confirm Subscription Switch |
|
|
52
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/cancel-auto-renew` | Cancel Auto-Renew |
|
|
53
|
-
| POST | `/customer-profile/subscriptions/{subscription_uuid}/initiate-early-payment` | Initiate Early Payment |
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
## Admin Endpoints
|
|
58
|
-
|
|
59
|
-
Admin endpoints require an authenticated WordPress user with the appropriate FluentCart capability. Authorization is handled by `OrderPolicy`.
|
|
60
|
-
|
|
61
|
-
### List Subscriptions
|
|
62
|
-
|
|
63
|
-
`GET /fluent-cart/v2/subscriptions`
|
|
64
|
-
|
|
65
|
-
Retrieve a paginated list of subscriptions with optional filtering, sorting, and search.
|
|
66
|
-
|
|
67
|
-
**Permission:** `subscriptions/view`
|
|
68
|
-
|
|
69
|
-
**Policy:** `OrderPolicy`
|
|
70
|
-
|
|
71
|
-
#### Parameters
|
|
72
|
-
|
|
73
|
-
| Parameter | Type | Location | Required | Description |
|
|
74
|
-
|-----------|------|----------|----------|-------------|
|
|
75
|
-
| `page` | integer | query | No | Page number for pagination |
|
|
76
|
-
| `per_page` | integer | query | No | Number of records per page (default: 10, max: 200) |
|
|
77
|
-
| `search` | string | query | No | Search term (`#123` for ID, `user@example.com` for email, `canceled`, or general text across vendor IDs, payment method, interval) |
|
|
78
|
-
| `sort_by` | string | query | No | Column to sort by (default: `id`) |
|
|
79
|
-
| `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
|
|
80
|
-
| `active_view` | string | query | No | Tab filter: `active`, `pending`, `intended`, `paused`, `trialing`, `canceled`, `failing`, `expiring`, `expired` |
|
|
81
|
-
| `filter_type` | string | query | No | Filter mode: `simple` (default) or `advanced` |
|
|
82
|
-
| `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups (requires Pro) |
|
|
83
|
-
| `with` | array/string | query | No | Eager-load relations |
|
|
84
|
-
| `select` | array/string | query | No | Comma-separated list of columns to select |
|
|
85
|
-
| `scopes` | array | query | No | Model scopes to apply |
|
|
86
|
-
| `include_ids` | array/string | query | No | Comma-separated IDs that must always be included |
|
|
87
|
-
| `limit` | integer | query | No | Limit number of records |
|
|
88
|
-
| `offset` | integer | query | No | Offset for records |
|
|
89
|
-
| `user_tz` | string | query | No | User timezone for date filtering (e.g., `America/New_York`) |
|
|
90
|
-
|
|
91
|
-
#### Response
|
|
92
|
-
|
|
93
|
-
```json
|
|
94
|
-
{
|
|
95
|
-
"data": {
|
|
96
|
-
"current_page": 1,
|
|
97
|
-
"data": [
|
|
98
|
-
{
|
|
99
|
-
"id": 1,
|
|
100
|
-
"uuid": "abc123-def456",
|
|
101
|
-
"status": "active",
|
|
102
|
-
"item_name": "Pro Plan",
|
|
103
|
-
"parent_order_id": 10,
|
|
104
|
-
"customer_id": 5,
|
|
105
|
-
"product_id": 3,
|
|
106
|
-
"variation_id": 7,
|
|
107
|
-
"vendor_subscription_id": "sub_1234567890",
|
|
108
|
-
"vendor_customer_id": "cus_abc123",
|
|
109
|
-
"vendor_plan_id": "price_xyz789",
|
|
110
|
-
"current_payment_method": "stripe",
|
|
111
|
-
"billing_interval": "monthly",
|
|
112
|
-
"recurring_amount": 2999,
|
|
113
|
-
"bill_times": 0,
|
|
114
|
-
"bill_count": 6,
|
|
115
|
-
"next_billing_date": "2025-02-15 00:00:00",
|
|
116
|
-
"created_at": "2025-01-15 10:30:00",
|
|
117
|
-
"updated_at": "2025-01-15 10:35:00"
|
|
118
|
-
}
|
|
119
|
-
],
|
|
120
|
-
"per_page": 10,
|
|
121
|
-
"total": 50,
|
|
122
|
-
"last_page": 5
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
#### Example
|
|
128
|
-
|
|
129
|
-
```bash
|
|
130
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/subscriptions?page=1&per_page=10&active_view=active" \
|
|
131
|
-
-u "username:app_password"
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
### Get Subscription Details
|
|
137
|
-
|
|
138
|
-
`GET /fluent-cart/v2/subscriptions/{subscriptionOrderId}`
|
|
139
|
-
|
|
140
|
-
Retrieve the full details of a single subscription including customer addresses, labels, activities, and related orders.
|
|
141
|
-
|
|
142
|
-
**Permission:** `subscriptions/view`
|
|
143
|
-
|
|
144
|
-
**Policy:** `OrderPolicy`
|
|
145
|
-
|
|
146
|
-
#### Parameters
|
|
147
|
-
|
|
148
|
-
| Parameter | Type | Location | Required | Description |
|
|
149
|
-
|-----------|------|----------|----------|-------------|
|
|
150
|
-
| `subscriptionOrderId` | integer | path | Yes | The subscription ID |
|
|
151
|
-
|
|
152
|
-
#### Response
|
|
153
|
-
|
|
154
|
-
```json
|
|
155
|
-
{
|
|
156
|
-
"subscription": {
|
|
157
|
-
"id": 1,
|
|
158
|
-
"uuid": "abc123-def456",
|
|
159
|
-
"status": "active",
|
|
160
|
-
"item_name": "Pro Plan",
|
|
161
|
-
"parent_order_id": 10,
|
|
162
|
-
"customer_id": 5,
|
|
163
|
-
"product_id": 3,
|
|
164
|
-
"variation_id": 7,
|
|
165
|
-
"vendor_subscription_id": "sub_1234567890",
|
|
166
|
-
"vendor_customer_id": "cus_abc123",
|
|
167
|
-
"current_payment_method": "stripe",
|
|
168
|
-
"billing_interval": "monthly",
|
|
169
|
-
"recurring_amount": 2999,
|
|
170
|
-
"bill_times": 0,
|
|
171
|
-
"bill_count": 6,
|
|
172
|
-
"next_billing_date": "2025-02-15 00:00:00",
|
|
173
|
-
"billing_address": { ... },
|
|
174
|
-
"shipping_address": { ... },
|
|
175
|
-
"labels": [ ... ],
|
|
176
|
-
"activities": [ ... ],
|
|
177
|
-
"customer": {
|
|
178
|
-
"id": 5,
|
|
179
|
-
"shipping_address": { ... },
|
|
180
|
-
"billing_address": { ... }
|
|
181
|
-
},
|
|
182
|
-
"related_orders": [
|
|
183
|
-
{
|
|
184
|
-
"id": 10,
|
|
185
|
-
"order_items": [
|
|
186
|
-
{
|
|
187
|
-
"id": 1,
|
|
188
|
-
"order_id": 10,
|
|
189
|
-
"post_title": "Pro Plan",
|
|
190
|
-
"title": "Pro Plan",
|
|
191
|
-
"quantity": 1,
|
|
192
|
-
"payment_type": "subscription",
|
|
193
|
-
"line_meta": { ... }
|
|
194
|
-
}
|
|
195
|
-
]
|
|
196
|
-
}
|
|
197
|
-
]
|
|
198
|
-
},
|
|
199
|
-
"selected_labels": [1, 3, 5]
|
|
200
|
-
}
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
#### Example
|
|
204
|
-
|
|
205
|
-
```bash
|
|
206
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/subscriptions/1" \
|
|
207
|
-
-u "username:app_password"
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
---
|
|
211
|
-
|
|
212
|
-
### Cancel Subscription
|
|
213
|
-
|
|
214
|
-
`PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/cancel`
|
|
215
|
-
|
|
216
|
-
Cancel a subscription both locally and with the remote payment gateway.
|
|
217
|
-
|
|
218
|
-
**Permission:** `subscriptions/manage`
|
|
219
|
-
|
|
220
|
-
**Policy:** `OrderPolicy`
|
|
221
|
-
|
|
222
|
-
#### Parameters
|
|
223
|
-
|
|
224
|
-
| Parameter | Type | Location | Required | Description |
|
|
225
|
-
|-----------|------|----------|----------|-------------|
|
|
226
|
-
| `order` | integer | path | Yes | The parent order ID |
|
|
227
|
-
| `subscription` | integer | path | Yes | The subscription ID |
|
|
228
|
-
| `cancel_reason` | string | body | Yes | Reason for cancellation |
|
|
229
|
-
|
|
230
|
-
#### Response
|
|
231
|
-
|
|
232
|
-
```json
|
|
233
|
-
{
|
|
234
|
-
"message": "Subscription has been cancelled successfully!",
|
|
235
|
-
"subscription": {
|
|
236
|
-
"id": 1,
|
|
237
|
-
"status": "canceled"
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
#### Example
|
|
243
|
-
|
|
244
|
-
```bash
|
|
245
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/cancel" \
|
|
246
|
-
-u "username:app_password" \
|
|
247
|
-
-H "Content-Type: application/json" \
|
|
248
|
-
-d '{"cancel_reason": "Customer requested cancellation"}'
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
---
|
|
252
|
-
|
|
253
|
-
### Fetch Subscription from Remote
|
|
254
|
-
|
|
255
|
-
`PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/fetch`
|
|
256
|
-
|
|
257
|
-
Re-sync a subscription's data from the remote payment gateway (e.g., Stripe, PayPal).
|
|
258
|
-
|
|
259
|
-
**Permission:** `subscriptions/view`
|
|
260
|
-
|
|
261
|
-
**Policy:** `OrderPolicy`
|
|
262
|
-
|
|
263
|
-
#### Parameters
|
|
264
|
-
|
|
265
|
-
| Parameter | Type | Location | Required | Description |
|
|
266
|
-
|-----------|------|----------|----------|-------------|
|
|
267
|
-
| `order` | integer | path | Yes | The parent order ID |
|
|
268
|
-
| `subscription` | integer | path | Yes | The subscription ID |
|
|
269
|
-
|
|
270
|
-
#### Response
|
|
271
|
-
|
|
272
|
-
```json
|
|
273
|
-
{
|
|
274
|
-
"message": "Subscription fetched successfully from remote payment gateway!",
|
|
275
|
-
"subscription": {
|
|
276
|
-
"id": 1,
|
|
277
|
-
"status": "active",
|
|
278
|
-
"vendor_subscription_id": "sub_1234567890"
|
|
279
|
-
}
|
|
280
|
-
}
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
#### Example
|
|
284
|
-
|
|
285
|
-
```bash
|
|
286
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/fetch" \
|
|
287
|
-
-u "username:app_password"
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
---
|
|
291
|
-
|
|
292
|
-
### Generate Early Payment Link
|
|
293
|
-
|
|
294
|
-
`POST /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/early-payment-link`
|
|
295
|
-
|
|
296
|
-
Generate a URL that allows early payment of remaining installments on an installment-based subscription.
|
|
297
|
-
|
|
298
|
-
**Permission:** `subscriptions/manage`
|
|
299
|
-
|
|
300
|
-
**Policy:** `OrderPolicy`
|
|
301
|
-
|
|
302
|
-
#### Parameters
|
|
303
|
-
|
|
304
|
-
| Parameter | Type | Location | Required | Description |
|
|
305
|
-
|-----------|------|----------|----------|-------------|
|
|
306
|
-
| `order` | integer | path | Yes | The parent order ID |
|
|
307
|
-
| `subscription` | integer | path | Yes | The subscription ID |
|
|
308
|
-
|
|
309
|
-
#### Response
|
|
310
|
-
|
|
311
|
-
```json
|
|
312
|
-
{
|
|
313
|
-
"message": "Early payment link generated.",
|
|
314
|
-
"payment_url": "https://your-site.com/?fluent-cart=early-installment-payment&subscription_hash=abc123-def456"
|
|
315
|
-
}
|
|
316
|
-
```
|
|
317
|
-
|
|
318
|
-
#### Example
|
|
319
|
-
|
|
320
|
-
```bash
|
|
321
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/early-payment-link" \
|
|
322
|
-
-u "username:app_password"
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
---
|
|
326
|
-
|
|
327
|
-
### Charge Subscription Now
|
|
328
|
-
|
|
329
|
-
`POST /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/charge-now`
|
|
330
|
-
|
|
331
|
-
Run one immediate off-session charge attempt against a subscription's open renewal invoice. Requires a store-billed (manual or auto-charge) subscription that already has a pending or scheduled renewal order.
|
|
332
|
-
|
|
333
|
-
A declined card is returned as **HTTP 200 with `status: "failed"`** — the request itself succeeded, the charge attempt did not. Only a state violation (e.g. no open renewal order to charge) returns an error response, so branch on the body, not solely on the status code.
|
|
334
|
-
|
|
335
|
-
**Permission:** `subscriptions/manage`
|
|
336
|
-
|
|
337
|
-
#### Parameters
|
|
338
|
-
|
|
339
|
-
| Parameter | Type | Location | Required | Description |
|
|
340
|
-
|-----------|------|----------|----------|-------------|
|
|
341
|
-
| `order` | integer | path | Yes | Parent order ID the subscription belongs to |
|
|
342
|
-
| `subscription` | integer | path | Yes | Subscription ID |
|
|
343
|
-
|
|
344
|
-
#### Example
|
|
345
|
-
|
|
346
|
-
```bash
|
|
347
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/charge-now" \
|
|
348
|
-
-u "username:app_password"
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
---
|
|
352
|
-
|
|
353
|
-
### Create Renewal Now
|
|
354
|
-
|
|
355
|
-
`POST /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/create-renewal`
|
|
356
|
-
|
|
357
|
-
Immediately create the next renewal order for a store-billed (manual or auto-charge) subscription, ahead of its scheduled billing date. Only valid for `active` or `trialing` subscriptions that have an upcoming billing date.
|
|
358
|
-
|
|
359
|
-
For auto-charge (system) subscriptions the newly created — or already-open — renewal is charged immediately; for manual subscriptions it produces an invoice the customer pays.
|
|
360
|
-
|
|
361
|
-
**Permission:** `subscriptions/manage`
|
|
362
|
-
|
|
363
|
-
#### Parameters
|
|
364
|
-
|
|
365
|
-
| Parameter | Type | Location | Required | Description |
|
|
366
|
-
|-----------|------|----------|----------|-------------|
|
|
367
|
-
| `order` | integer | path | Yes | Parent order ID the subscription belongs to |
|
|
368
|
-
| `subscription` | integer | path | Yes | Subscription ID |
|
|
369
|
-
|
|
370
|
-
#### Example
|
|
371
|
-
|
|
372
|
-
```bash
|
|
373
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/create-renewal" \
|
|
374
|
-
-u "username:app_password"
|
|
375
|
-
```
|
|
376
|
-
|
|
377
|
-
---
|
|
378
|
-
|
|
379
|
-
### Skip Next Renewal Period
|
|
380
|
-
|
|
381
|
-
`POST /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/skip-renewal`
|
|
382
|
-
|
|
383
|
-
Advance a store-billed (manual or auto-charge) subscription's `next_billing_date` to the following period **without** creating or charging a renewal for the current one. Only valid for `active` or `trialing` subscriptions with an upcoming billing date.
|
|
384
|
-
|
|
385
|
-
The skip does not stack — if a skip is already pending, or there is nothing left to advance, the request fails.
|
|
386
|
-
|
|
387
|
-
**Permission:** `subscriptions/manage`
|
|
388
|
-
|
|
389
|
-
#### Parameters
|
|
390
|
-
|
|
391
|
-
| Parameter | Type | Location | Required | Description |
|
|
392
|
-
|-----------|------|----------|----------|-------------|
|
|
393
|
-
| `order` | integer | path | Yes | Parent order ID the subscription belongs to |
|
|
394
|
-
| `subscription` | integer | path | Yes | Subscription ID |
|
|
395
|
-
| `reason` | string | body | No | Note recorded against the skip |
|
|
396
|
-
|
|
397
|
-
#### Example
|
|
398
|
-
|
|
399
|
-
```bash
|
|
400
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/skip-renewal" \
|
|
401
|
-
-u "username:app_password" \
|
|
402
|
-
-H "Content-Type: application/json" \
|
|
403
|
-
-d '{"reason":"Customer travelling"}'
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
---
|
|
407
|
-
|
|
408
|
-
### Update Subscription
|
|
409
|
-
|
|
410
|
-
`PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/update`
|
|
411
|
-
|
|
412
|
-
Update a manual subscription's billing details — recurring amount, remaining bill count, billing interval, status, or next billing date. Only subscriptions with a **manual** collection method can be updated through this endpoint; system (auto-charge) and gateway-managed subscriptions are rejected.
|
|
413
|
-
|
|
414
|
-
> `recurring_total` is a decimal amount in the store's currency (e.g. `29.99`), **not cents** — unlike almost every other money field in this API.
|
|
415
|
-
|
|
416
|
-
**Permission:** `subscriptions/manage`
|
|
417
|
-
|
|
418
|
-
#### Parameters
|
|
419
|
-
|
|
420
|
-
| Parameter | Type | Location | Required | Description |
|
|
421
|
-
|-----------|------|----------|----------|-------------|
|
|
422
|
-
| `order` | integer | path | Yes | Parent order ID the subscription belongs to |
|
|
423
|
-
| `subscription` | integer | path | Yes | Subscription ID |
|
|
424
|
-
| `status` | string | body | Yes | New status: `active`, `paused`, `trialing`, `canceled`, `expired`, `completed`, `past_due` |
|
|
425
|
-
| `recurring_total` | number | body | No | New recurring amount as a decimal (`29.99`), not cents |
|
|
426
|
-
| `bill_times` | integer | body | No | Number of remaining billing cycles |
|
|
427
|
-
| `billing_interval` | string | body | No | Interval label (e.g. `monthly`, `yearly`) |
|
|
428
|
-
| `next_billing_date` | string | body | No | Any string `strtotime()` can parse |
|
|
429
|
-
|
|
430
|
-
#### Example
|
|
431
|
-
|
|
432
|
-
```bash
|
|
433
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/update" \
|
|
434
|
-
-u "username:app_password" \
|
|
435
|
-
-H "Content-Type: application/json" \
|
|
436
|
-
-d '{"status":"active","recurring_total":29.99,"billing_interval":"monthly","bill_times":12}'
|
|
437
|
-
```
|
|
438
|
-
|
|
439
|
-
---
|
|
440
|
-
|
|
441
|
-
### Update Vendor IDs
|
|
442
|
-
|
|
443
|
-
`PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/vendor-ids`
|
|
444
|
-
|
|
445
|
-
Correct the gateway identifiers (`vendor_subscription_id`, `vendor_customer_id`) on a gateway-billed subscription.
|
|
446
|
-
|
|
447
|
-
Opt-in: the endpoint returns an error unless the site returns `true` from the `fluent_cart/subscription/vendor_id_editing_enabled` filter. It writes only the identifier columns — no renewal is voided, no invoice re-synced, no status event dispatched, and the payment gateway is not called. Only the keys you send are written; send an empty string to clear one.
|
|
448
|
-
|
|
449
|
-
The new `vendor_subscription_id` is claimed atomically, so another subscription on the same payment method cannot already hold it.
|
|
450
|
-
|
|
451
|
-
**Permission:** `subscriptions/manage`
|
|
452
|
-
|
|
453
|
-
#### Parameters
|
|
454
|
-
|
|
455
|
-
| Parameter | Type | Location | Required | Description |
|
|
456
|
-
|-----------|------|----------|----------|-------------|
|
|
457
|
-
| `order` | integer | path | Yes | The parent order ID |
|
|
458
|
-
| `subscription` | integer | path | Yes | The subscription ID |
|
|
459
|
-
| `vendor_subscription_id` | string | body | No | Subscription ID at the payment gateway. Empty string clears it; omit to leave untouched. Max 45 chars, `^[a-zA-Z0-9_.-]+$` |
|
|
460
|
-
| `vendor_customer_id` | string | body | No | Customer ID at the payment gateway. Empty string clears it; omit to leave untouched. Max 45 chars, `^[a-zA-Z0-9_.-]+$` |
|
|
461
|
-
|
|
462
|
-
#### Example
|
|
463
|
-
|
|
464
|
-
```bash
|
|
465
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/vendor-ids" \
|
|
466
|
-
-u "username:app_password" \
|
|
467
|
-
-H "Content-Type: application/json" \
|
|
468
|
-
-d '{"vendor_subscription_id":"sub_1QxYzAbC"}'
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
---
|
|
472
|
-
|
|
473
|
-
### Verify Vendor IDs
|
|
474
|
-
|
|
475
|
-
`POST /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/verify-vendor-ids`
|
|
476
|
-
|
|
477
|
-
Read-only lookup of a candidate vendor subscription ID at the payment gateway, used before saving a correction. Writes nothing locally and nothing at the gateway.
|
|
478
|
-
|
|
479
|
-
Requires the `fluent_cart/subscription/vendor_id_editing_enabled` filter and a gateway declaring the `verify_vendor_ids` capability (Stripe and PayPal); other gateways return an error. A successful lookup proves the ID exists in the merchant account whose credentials this store holds — it is **not** proof of ownership, since one merchant account can back several stores.
|
|
480
|
-
|
|
481
|
-
**Permission:** `subscriptions/manage`
|
|
482
|
-
|
|
483
|
-
#### Parameters
|
|
484
|
-
|
|
485
|
-
| Parameter | Type | Location | Required | Description |
|
|
486
|
-
|-----------|------|----------|----------|-------------|
|
|
487
|
-
| `order` | integer | path | Yes | The parent order ID |
|
|
488
|
-
| `subscription` | integer | path | Yes | The subscription ID |
|
|
489
|
-
| `vendor_subscription_id` | string | body | No | The candidate subscription ID to look up. Max 45 chars, `^[a-zA-Z0-9_.-]+$` |
|
|
490
|
-
| `vendor_customer_id` | string | body | No | The candidate customer ID. Sent because some gateways nest the subscription under its customer. Max 45 chars, `^[a-zA-Z0-9_.-]+$` |
|
|
491
|
-
|
|
492
|
-
#### Response
|
|
493
|
-
|
|
494
|
-
```json
|
|
495
|
-
{
|
|
496
|
-
"message": "Subscription found at the payment gateway.",
|
|
497
|
-
"verification": {
|
|
498
|
-
"id": "sub_1PxaBcDeFgHiJkLmNoPqRsTu",
|
|
499
|
-
"status": "active",
|
|
500
|
-
"customer_id": "cus_QrStUvWxYz012345",
|
|
501
|
-
"amount": 9900,
|
|
502
|
-
"currency": "USD",
|
|
503
|
-
"next_billing_date": "2027-05-29 12:35:43"
|
|
504
|
-
}
|
|
505
|
-
}
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
#### Example
|
|
509
|
-
|
|
510
|
-
```bash
|
|
511
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/10/subscriptions/1/verify-vendor-ids" \
|
|
512
|
-
-u "username:app_password" \
|
|
513
|
-
-H "Content-Type: application/json" \
|
|
514
|
-
-d '{"vendor_subscription_id":"sub_1P9xyzABCdef","vendor_customer_id":"cus_NffrFeUfNV2Hib"}'
|
|
515
|
-
```
|
|
516
|
-
|
|
517
|
-
---
|
|
518
|
-
|
|
519
|
-
### Reserved Admin Endpoints
|
|
520
|
-
|
|
521
|
-
- `PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/reactivate`
|
|
522
|
-
- `PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/pause`
|
|
523
|
-
- `PUT /fluent-cart/v2/orders/{order}/subscriptions/{subscription}/resume`
|
|
524
|
-
|
|
525
|
-
*Note: Registered but currently return "Not available yet". Reserved for future implementation.*
|
|
526
|
-
|
|
527
|
-
---
|
|
528
|
-
|
|
529
|
-
## Renewal Invoices
|
|
530
|
-
|
|
531
|
-
A renewal invoice is just an order with `type = "renewal"`, so these endpoints read and act on the order record rather than a separate table. They are the admin-side controls for chasing and cleaning up unpaid renewals.
|
|
532
|
-
|
|
533
|
-
### List Renewal Invoices
|
|
534
|
-
|
|
535
|
-
`GET /fluent-cart/v2/renewals`
|
|
536
|
-
|
|
537
|
-
List orders of type `renewal` (subscription renewal invoices), newest first, paginated. Each row includes its `customer` relation.
|
|
538
|
-
|
|
539
|
-
**Permission:** `orders/view`
|
|
540
|
-
|
|
541
|
-
**Policy:** `OrderPolicy`
|
|
542
|
-
|
|
543
|
-
#### Parameters
|
|
544
|
-
|
|
545
|
-
| Parameter | Type | Location | Required | Description |
|
|
546
|
-
|-----------|------|----------|----------|-------------|
|
|
547
|
-
| `payment_status` | string | query | No | Filter by payment status (e.g. `paid`, `pending`, `failed`) |
|
|
548
|
-
| `parent_id` | integer | query | No | Only renewal invoices belonging to this parent order ID |
|
|
549
|
-
| `customer_id` | integer | query | No | Only renewal invoices belonging to this customer ID |
|
|
550
|
-
|
|
551
|
-
#### Response
|
|
552
|
-
|
|
553
|
-
```json
|
|
554
|
-
{
|
|
555
|
-
"invoices": {
|
|
556
|
-
"current_page": 1,
|
|
557
|
-
"data": [
|
|
558
|
-
{
|
|
559
|
-
"id": 5151,
|
|
560
|
-
"status": "completed",
|
|
561
|
-
"parent_id": "1880",
|
|
562
|
-
"receipt_number": "6322",
|
|
563
|
-
"invoice_no": "INV-6322",
|
|
564
|
-
"fulfillment_type": "digital",
|
|
565
|
-
"type": "renewal",
|
|
566
|
-
"mode": "live",
|
|
567
|
-
"shipping_status": "unshipped",
|
|
568
|
-
"customer_id": 1484
|
|
569
|
-
}
|
|
570
|
-
]
|
|
571
|
-
}
|
|
572
|
-
}
|
|
573
|
-
```
|
|
574
|
-
|
|
575
|
-
`invoices` is a Laravel paginator payload (`current_page`, `data`, `total`, `per_page`, …).
|
|
576
|
-
|
|
577
|
-
---
|
|
578
|
-
|
|
579
|
-
### Get Renewal Invoice Details
|
|
580
|
-
|
|
581
|
-
`GET /fluent-cart/v2/renewals/{id}`
|
|
582
|
-
|
|
583
|
-
Retrieve a single renewal invoice, including its customer, order items and transactions.
|
|
584
|
-
|
|
585
|
-
**Permission:** `orders/view`
|
|
586
|
-
|
|
587
|
-
**Policy:** `OrderPolicy`
|
|
588
|
-
|
|
589
|
-
#### Parameters
|
|
590
|
-
|
|
591
|
-
| Parameter | Type | Location | Required | Description |
|
|
592
|
-
|-----------|------|----------|----------|-------------|
|
|
593
|
-
| `id` | integer | path | Yes | Renewal order ID |
|
|
594
|
-
|
|
595
|
-
---
|
|
596
|
-
|
|
597
|
-
### Resend Renewal Invoice Email
|
|
598
|
-
|
|
599
|
-
`POST /fluent-cart/v2/renewals/{order}/resend`
|
|
600
|
-
|
|
601
|
-
Resend the pay-now email for a pending renewal invoice. Only allowed when `payment_status = pending`.
|
|
602
|
-
|
|
603
|
-
If the invoice belongs to a system (store-managed) subscription that is still mid-retry, the resend is **blocked until the automatic retry ladder is exhausted**, so it never overlaps the dunning emails.
|
|
604
|
-
|
|
605
|
-
**Permission:** `orders/manage`
|
|
606
|
-
|
|
607
|
-
**Policy:** `OrderPolicy`
|
|
608
|
-
|
|
609
|
-
#### Parameters
|
|
610
|
-
|
|
611
|
-
| Parameter | Type | Location | Required | Description |
|
|
612
|
-
|-----------|------|----------|----------|-------------|
|
|
613
|
-
| `order` | integer | path | Yes | Renewal order ID |
|
|
614
|
-
|
|
615
|
-
#### Response
|
|
616
|
-
|
|
617
|
-
```json
|
|
618
|
-
{ "message": "Renewal order email has been resent" }
|
|
619
|
-
```
|
|
620
|
-
|
|
621
|
-
---
|
|
622
|
-
|
|
623
|
-
### Void Renewal Invoice
|
|
624
|
-
|
|
625
|
-
`POST /fluent-cart/v2/renewals/{order}/void`
|
|
626
|
-
|
|
627
|
-
Cancel a pending or scheduled renewal invoice. This is not a soft delete — it:
|
|
628
|
-
|
|
629
|
-
1. sets the order's `payment_status` to `failed` and `status` to `canceled`,
|
|
630
|
-
2. fails any pending transactions on it,
|
|
631
|
-
3. advances the subscription past this billing period, so the scheduler does not immediately regenerate the same invoice,
|
|
632
|
-
4. recounts the customer's stats.
|
|
633
|
-
|
|
634
|
-
If a concurrent webhook pays the invoice between validation and the update, the void is **rejected** rather than overwriting a paid invoice.
|
|
635
|
-
|
|
636
|
-
**Permission:** `orders/manage`
|
|
637
|
-
|
|
638
|
-
**Policy:** `OrderPolicy`
|
|
639
|
-
|
|
640
|
-
#### Parameters
|
|
641
|
-
|
|
642
|
-
| Parameter | Type | Location | Required | Description |
|
|
643
|
-
|-----------|------|----------|----------|-------------|
|
|
644
|
-
| `order` | integer | path | Yes | Renewal order ID |
|
|
645
|
-
|
|
646
|
-
#### Response
|
|
647
|
-
|
|
648
|
-
```json
|
|
649
|
-
{ "message": "Renewal order has been voided successfully" }
|
|
650
|
-
```
|
|
651
|
-
|
|
652
|
-
---
|
|
653
|
-
|
|
654
|
-
## Customer Portal Endpoints
|
|
655
|
-
|
|
656
|
-
Authenticated via logged-in WordPress user session. Uses subscription `uuid` (not numeric ID). Authorization: `CustomerFrontendPolicy`.
|
|
657
|
-
|
|
658
|
-
### List Customer Subscriptions
|
|
659
|
-
|
|
660
|
-
`GET /fluent-cart/v2/customer-profile/subscriptions`
|
|
661
|
-
|
|
662
|
-
Retrieve a paginated list of subscriptions belonging to the currently logged-in customer. Pending/intended subscriptions are excluded.
|
|
663
|
-
|
|
664
|
-
**Auth:** Logged-in WordPress user
|
|
665
|
-
|
|
666
|
-
**Policy:** `CustomerFrontendPolicy`
|
|
667
|
-
|
|
668
|
-
#### Parameters
|
|
669
|
-
|
|
670
|
-
| Parameter | Type | Location | Required | Description |
|
|
671
|
-
|-----------|------|----------|----------|-------------|
|
|
672
|
-
| `page` | integer | query | No | Page number for pagination (default: 1) |
|
|
673
|
-
| `per_page` | integer | query | No | Number of records per page (default: 10) |
|
|
674
|
-
|
|
675
|
-
#### Response
|
|
676
|
-
|
|
677
|
-
```json
|
|
678
|
-
{
|
|
679
|
-
"message": "Success",
|
|
680
|
-
"subscriptions": {
|
|
681
|
-
"data": [
|
|
682
|
-
{
|
|
683
|
-
"uuid": "abc123-def456",
|
|
684
|
-
"status": "active",
|
|
685
|
-
"item_name": "Pro Plan",
|
|
686
|
-
"billing_interval": "monthly",
|
|
687
|
-
"recurring_amount": 2999,
|
|
688
|
-
"next_billing_date": "2025-02-15 00:00:00",
|
|
689
|
-
"bill_times": 0,
|
|
690
|
-
"bill_count": 6
|
|
691
|
-
}
|
|
692
|
-
],
|
|
693
|
-
"total": 5,
|
|
694
|
-
"per_page": 10,
|
|
695
|
-
"current_page": 1,
|
|
696
|
-
"last_page": 1
|
|
697
|
-
}
|
|
698
|
-
}
|
|
699
|
-
```
|
|
700
|
-
|
|
701
|
-
#### Example
|
|
702
|
-
|
|
703
|
-
```bash
|
|
704
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/customer-profile/subscriptions?page=1&per_page=10" \
|
|
705
|
-
-H "X-WP-Nonce: <nonce>"
|
|
706
|
-
```
|
|
707
|
-
|
|
708
|
-
---
|
|
709
|
-
|
|
710
|
-
### Get Customer Subscription Details
|
|
711
|
-
|
|
712
|
-
`GET /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}`
|
|
713
|
-
|
|
714
|
-
Retrieve full details of a specific subscription for the currently logged-in customer, including transactions, upgrade eligibility, and payment method capabilities.
|
|
715
|
-
|
|
716
|
-
**Auth:** Logged-in WordPress user
|
|
717
|
-
|
|
718
|
-
**Policy:** `CustomerFrontendPolicy`
|
|
719
|
-
|
|
720
|
-
#### Parameters
|
|
721
|
-
|
|
722
|
-
| Parameter | Type | Location | Required | Description |
|
|
723
|
-
|-----------|------|----------|----------|-------------|
|
|
724
|
-
| `subscription_uuid` | string | path | Yes | The subscription UUID |
|
|
725
|
-
|
|
726
|
-
#### Response
|
|
727
|
-
|
|
728
|
-
```json
|
|
729
|
-
{
|
|
730
|
-
"message": "Success",
|
|
731
|
-
"subscription": {
|
|
732
|
-
"uuid": "abc123-def456",
|
|
733
|
-
"status": "active",
|
|
734
|
-
"overridden_status": null,
|
|
735
|
-
"vendor_subscription_id": "sub_1234567890",
|
|
736
|
-
"next_billing_date": "2025-02-15 00:00:00",
|
|
737
|
-
"billing_info": {
|
|
738
|
-
"interval": "monthly",
|
|
739
|
-
"interval_count": 1,
|
|
740
|
-
"amount": 2999,
|
|
741
|
-
"currency": "USD"
|
|
742
|
-
},
|
|
743
|
-
"current_payment_method": "stripe",
|
|
744
|
-
"payment_method": "stripe",
|
|
745
|
-
"bill_times": 0,
|
|
746
|
-
"bill_count": 6,
|
|
747
|
-
"variation_id": 7,
|
|
748
|
-
"product_id": 3,
|
|
749
|
-
"reactivate_url": "https://your-site.com/?fluent-cart=reactivate&hash=abc123",
|
|
750
|
-
"title": "Pro Plan",
|
|
751
|
-
"can_upgrade": true,
|
|
752
|
-
"can_switch_payment_method": true,
|
|
753
|
-
"switchable_payment_methods": ["stripe", "paypal"],
|
|
754
|
-
"can_update_payment_method": true,
|
|
755
|
-
"order": {
|
|
756
|
-
"uuid": "order-uuid-here"
|
|
757
|
-
},
|
|
758
|
-
"billing_addresses": [ ... ],
|
|
759
|
-
"recurring_amount": 2999,
|
|
760
|
-
"can_early_pay": false,
|
|
761
|
-
"remaining_installments": 0,
|
|
762
|
-
"transactions": [ ... ]
|
|
763
|
-
}
|
|
764
|
-
}
|
|
765
|
-
```
|
|
766
|
-
|
|
767
|
-
#### Example
|
|
768
|
-
|
|
769
|
-
```bash
|
|
770
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/customer-profile/subscriptions/abc123-def456" \
|
|
771
|
-
-H "X-WP-Nonce: <nonce>"
|
|
772
|
-
```
|
|
773
|
-
|
|
774
|
-
---
|
|
775
|
-
|
|
776
|
-
### Get Setup Intent Remaining Attempts
|
|
777
|
-
|
|
778
|
-
`GET /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/setup-intent-attempts`
|
|
779
|
-
|
|
780
|
-
Check remaining Stripe SetupIntent attempts (Stripe only).
|
|
781
|
-
|
|
782
|
-
**Auth:** Logged-in WordPress user
|
|
783
|
-
|
|
784
|
-
#### Response
|
|
785
|
-
|
|
786
|
-
```json
|
|
787
|
-
{
|
|
788
|
-
"remaining": 5
|
|
789
|
-
}
|
|
790
|
-
```
|
|
791
|
-
|
|
792
|
-
---
|
|
793
|
-
|
|
794
|
-
### Update Payment Method
|
|
795
|
-
|
|
796
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/update-payment-method`
|
|
797
|
-
|
|
798
|
-
Update the payment method card/details on file within the same payment gateway.
|
|
799
|
-
|
|
800
|
-
**Auth:** Logged-in WordPress user
|
|
801
|
-
|
|
802
|
-
#### Parameters
|
|
803
|
-
|
|
804
|
-
| Parameter | Type | Location | Required | Description |
|
|
805
|
-
|-----------|------|----------|----------|-------------|
|
|
806
|
-
| `subscription_uuid` | string | path | Yes | The subscription UUID |
|
|
807
|
-
| `data.method` | string | body | Yes | Gateway slug (e.g., `stripe`, `paypal`) |
|
|
808
|
-
|
|
809
|
-
#### Example
|
|
810
|
-
|
|
811
|
-
```bash
|
|
812
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/customer-profile/subscriptions/abc123-def456/update-payment-method" \
|
|
813
|
-
-H "X-WP-Nonce: <nonce>" \
|
|
814
|
-
-H "Content-Type: application/json" \
|
|
815
|
-
-d '{
|
|
816
|
-
"data": {
|
|
817
|
-
"method": "stripe",
|
|
818
|
-
"payment_method_id": "pm_1234567890"
|
|
819
|
-
}
|
|
820
|
-
}'
|
|
821
|
-
```
|
|
822
|
-
|
|
823
|
-
---
|
|
824
|
-
|
|
825
|
-
### Get or Create Plan
|
|
826
|
-
|
|
827
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/get-or-create-plan`
|
|
828
|
-
|
|
829
|
-
Ensure target gateway has a matching plan configured during payment method switch.
|
|
830
|
-
|
|
831
|
-
**Auth:** Logged-in WordPress user
|
|
832
|
-
|
|
833
|
-
---
|
|
834
|
-
|
|
835
|
-
### Switch Payment Method
|
|
836
|
-
|
|
837
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/switch-payment-method`
|
|
838
|
-
|
|
839
|
-
Switch payment method from one gateway to another (e.g., Stripe to PayPal).
|
|
840
|
-
|
|
841
|
-
**Auth:** Logged-in WordPress user
|
|
842
|
-
|
|
843
|
-
#### Example
|
|
844
|
-
|
|
845
|
-
```bash
|
|
846
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/customer-profile/subscriptions/abc123-def456/switch-payment-method" \
|
|
847
|
-
-H "X-WP-Nonce: <nonce>" \
|
|
848
|
-
-H "Content-Type: application/json" \
|
|
849
|
-
-d '{
|
|
850
|
-
"data": {
|
|
851
|
-
"newPaymentMethod": "paypal",
|
|
852
|
-
"currentPaymentMethod": "stripe"
|
|
853
|
-
}
|
|
854
|
-
}'
|
|
855
|
-
```
|
|
856
|
-
|
|
857
|
-
---
|
|
858
|
-
|
|
859
|
-
### Confirm Subscription Switch
|
|
860
|
-
|
|
861
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/confirm-subscription-switch`
|
|
862
|
-
|
|
863
|
-
Confirm a two-step payment method switch on the target gateway.
|
|
864
|
-
|
|
865
|
-
**Auth:** Logged-in WordPress user
|
|
866
|
-
|
|
867
|
-
---
|
|
868
|
-
|
|
869
|
-
### Cancel Auto-Renew
|
|
870
|
-
|
|
871
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/cancel-auto-renew`
|
|
872
|
-
|
|
873
|
-
Cancel auto-renewal from customer portal (reasons set to `cancelled_by_customer`).
|
|
874
|
-
|
|
875
|
-
**Auth:** Logged-in WordPress user
|
|
876
|
-
|
|
877
|
-
#### Response
|
|
878
|
-
|
|
879
|
-
```json
|
|
880
|
-
{
|
|
881
|
-
"message": "Your subscription has been successfully cancelled"
|
|
882
|
-
}
|
|
883
|
-
```
|
|
884
|
-
|
|
885
|
-
#### Example
|
|
886
|
-
|
|
887
|
-
```bash
|
|
888
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/customer-profile/subscriptions/abc123-def456/cancel-auto-renew" \
|
|
889
|
-
-H "X-WP-Nonce: <nonce>"
|
|
890
|
-
```
|
|
891
|
-
|
|
892
|
-
---
|
|
893
|
-
|
|
894
|
-
### Initiate Early Payment
|
|
895
|
-
|
|
896
|
-
`POST /fluent-cart/v2/customer-profile/subscriptions/{subscription_uuid}/initiate-early-payment`
|
|
897
|
-
|
|
898
|
-
Generate a checkout URL for paying remaining installments early on installment subscriptions.
|
|
899
|
-
|
|
900
|
-
**Auth:** Logged-in WordPress user
|
|
901
|
-
|
|
902
|
-
#### Response
|
|
903
|
-
|
|
904
|
-
```json
|
|
905
|
-
{
|
|
906
|
-
"message": "Early payment URL generated.",
|
|
907
|
-
"checkout_url": "https://your-site.com/?fluent-cart=early-installment-payment&subscription_hash=abc123-def456"
|
|
908
|
-
}
|
|
909
|
-
```
|
|
910
|
-
|
|
911
|
-
---
|
|
912
|
-
|
|
913
|
-
## Subscription Statuses & Hooks Reference
|
|
914
|
-
|
|
915
|
-
### Statuses
|
|
916
|
-
|
|
917
|
-
| Status | Constant | Description |
|
|
918
|
-
|--------|----------|-------------|
|
|
919
|
-
| `pending` | `SUBSCRIPTION_PENDING` | Created but not yet activated |
|
|
920
|
-
| `intended` | `SUBSCRIPTION_INTENDED` | Payment intent created, awaiting completion |
|
|
921
|
-
| `trialing` | `SUBSCRIPTION_TRIALING` | In trial period |
|
|
922
|
-
| `active` | `SUBSCRIPTION_ACTIVE` | Active and billing normally |
|
|
923
|
-
| `paused` | `SUBSCRIPTION_PAUSED` | Temporarily paused |
|
|
924
|
-
| `failing` | `SUBSCRIPTION_FAILING` | Payment attempts failing |
|
|
925
|
-
| `expiring` | `SUBSCRIPTION_EXPIRING` | Approaching expiration |
|
|
926
|
-
| `expired` | `SUBSCRIPTION_EXPIRED` | Expired |
|
|
927
|
-
| `canceled` | `SUBSCRIPTION_CANCELED` | Cancelled by admin or customer |
|
|
928
|
-
| `past_due` | `SUBSCRIPTION_PAST_DUE` | Payment is overdue |
|
|
929
|
-
| `completed` | `SUBSCRIPTION_COMPLETED` | All installments paid |
|
|
930
|
-
| `authenticated` | `SUBSCRIPTION_AUTHENTICATED` | SCA flow completed |
|
|
931
|
-
| `created` | `SUBSCRIPTION_CREATED` | Created on remote gateway |
|
|
932
|
-
|
|
933
|
-
### Hooks & Filters
|
|
934
|
-
|
|
935
|
-
- `fluent_cart/subscription/view` — Filter subscription data before returning in admin detail view.
|
|
936
|
-
- `fluent_cart/customer_portal/subscription_data` — Filter subscription data in customer portal detail view.
|
|
937
|
-
- `fluent_cart/subscriptions_list_filter_query` — Filter subscription list query before execution.
|
|
938
|
-
- `fluent_cart/subscriptions_filter/{provider}/{property}` — Custom advanced filter handler.
|