Payment Methods

Sync a payment method's plans

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/payment-methods/$METHOD_ID/sync \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Queues a push of the project owner's plans into the gateway's catalogue (Stripe products and prices, PayPal, Razorpay or CoinPayments plans) and answers 202 Accepted. The work runs in the background; each plan reports through plan.sync_completed as it lands. Queuing twice pushes the same catalogue twice, which is harmless.

post/v1/projects/{project}/payment-methods/{method}/sync

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/payment-methods/{method}/sync
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

methodstring uuid required

The method, resolved within the project by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

The method id and sync_queued.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.