sync_payment_method_plans

Queue a push of the project's plans into a payment gateway's catalogue. Answers sync_queued; the work runs in the background.

Purpose

Some gateways keep their own catalogue — Stripe products and prices, PayPal, Razorpay and CoinPayments plans — and a subscription can only be sold through them once the plan exists there. Subscriby pushes the catalogue after every plan write and every method switch; this tool queues that push by hand, for the times a gateway was reconfigured or a sync failed and the creator wants it re-run now.

The answer is sync_queued, not a result: the work runs in the background and each plan reports through the plan-sync webhook events as it lands. Idempotent in the sense that it can be repeated safely — queuing twice pushes the same catalogue twice, which changes nothing.

Not every gateway has a catalogue

Telegram Stars, access codes and the redirect gateways (Paystack, CeyPay, Skrill) take the price at checkout and keep no plan objects, so a sync for them is refused with VALIDATION_FAILED rather than queued as a no-op.

Required ability

project-payment-method:update

Input schema

{
  "type": "object",
  "required": ["project_id", "payment_method_id"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project the method belongs to."
    },
    "payment_method_id": {
      "type": "string",
      "description": "UUID of the payment method whose gateway catalogue to refresh."
    }
  }
}

Output shape

{
  "data": {
    "payment_method_id": "a15d70c8-3e46-4b92-b70f-58c9d2140e63",
    "status": "sync_queued"
  }
}

Example prompts

"Re-sync the plans to Stripe for project 7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13."

"The Razorpay plans look stale — push the catalogue again."

"Queue a plan sync for payment method a15d70c8-3e46-4b92-b70f-58c9d2140e63."

Failure modes

VALIDATION_FAILED — the gateway keeps no catalogue (connector currencies, access codes, the redirect gateways).
RESOURCE_NOT_FOUND — unknown project_id or payment_method_id, a method of another project, or a project outside the token's scope.
AUTHENTICATION_REQUIRED — no authenticated user on the request.
TOKEN_MISSING_ABILITY — token lacks project-payment-method:update.

list_payment_methods — which gateways the project has.
update_plan — a plan write queues the same sync itself.
Payment methods API — the REST equivalent, a 202.