billing
POST /v1/subscriptions/{subscriptionId}/billing-rail
Choose which clock charges this subscription.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/billing-rail \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "rail": <string<engine, paypal>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Move a subscription between the engine rail (we invoice and charge on the renewal date) and the PayPal rail (PayPal charges on its own schedule under an agreement the customer approved). ADR 0029 records the boundary: PayPal owns only when the money is taken — the engine still owns what is owed, tax, entitlements, dunning and suspension. ⛔⛔ Switching to PayPal returns an approval_url and grants nothing. Until the buyer approves in PayPal's own interface and PayPal sends us a signed BILLING.SUBSCRIPTION.ACTIVATED webhook, the agreement cannot charge and the subscription's clock has not started. active is false for exactly that reason. The browser's return from the approval URL is an attacker-supplied claim and is never treated as approval. Switching away cancels the agreement at PayPal first and unbinds second. The reverse order would hand the subscription back to the engine's renewal sweep while PayPal was still entitled to charge it — a double charge for the window between the two calls. Requires billing.payment.manage. 422 carries a code: ALREADY_ON_RAIL, NO_CATALOGUE_PRICE, PRICE_WOULD_CHANGE (the subscription is on a price that differs from the published one, so switching would change what the customer pays — refused rather than done quietly), NOT_SWITCHABLE, or PAYPAL_REFUSED.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
subscriptionId (path) | Uuid | Igen | The subscription whose recurring rail is being changed. |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
rail | string<engine, paypal> | Igen | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
rail | string<engine, paypal> | Igen | — |
approval_url | object | Nem | Where the buyer must approve the PayPal agreement. ⛔⛔… |
active | boolean | Igen | Whether the named rail is charging yet. false immediately after switching to PayPal — a client that rendered "you are now billed by PayPal" here would be telling the customer… |
paypal_subscription_id | string | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422 · 429