billing
PUT /v1/subscriptions/{subscriptionId}/crypto-auto-renew
Turn crypto auto-renew on or off for this subscription.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/crypto-auto-renew \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
On: the subscription keeps renewing on the engine's own clock (the renewal invoice, its tax and the reminder ladder are unchanged), and at the first renewal that needs paying NOWPayments starts e-mailing a payment link for the renewal amount including tax. What the customer pays is credited to the account and settles the renewal invoice. ⛔ A subscription on crypto auto-renew is never charged on a stored card or PayPal — paying the link is the payment. Turning it on also turns renewal on. Off: NOWPayments is told to stop first; the next renewal is invoiced as usual. Turning renewal off, moving to PayPal billing or cancelling also turns this off. email defaults to the billing e-mail. Requires billing.payment.manage. 422 carries a code: CRYPTO_AUTO_RENEW_UNAVAILABLE, CRYPTO_AUTO_RENEW_OTHER_RAIL, CRYPTO_AUTO_RENEW_NOT_LIVE, CRYPTO_AUTO_RENEW_NOT_BILLABLE or CRYPTO_AUTO_RENEW_EMAIL.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
subscriptionId (path) | Uuid | Yes | The subscription whose crypto auto-renew choice is read or changed. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | — |
email | string | No | Where NOWPayments sends the payment links. Defaults to the billing e-mail. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
available | boolean | Yes | Whether customers can choose crypto auto-renew right now. |
enabled | boolean | Yes | — |
status | string<off, scheduled, active> | Yes | scheduled — chosen; the first link is e-mailed at the next renewal. active — NOWPayments is sending links each period. |
subscription_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
email | string | No | — |
amount_minor | object | No | The renewal amount each link asks for, tax included, in minor units. |
currency | object | No | — |
interval_days | object | No | — |
vendor_status | string | No | The processor's last status (WAITING_PAY, PAID, PARTIALLY_PAID, EXPIRED) or empty. |
last_paid_at | object | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429