billing
GET /v1/subscriptions/{subscriptionId}/crypto-auto-renew
Read this subscription's crypto auto-renew choice.
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 GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/crypto-auto-renew \
-H "Authorization: Bearer zdk_live_…"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
Whether the subscription renews by a crypto payment link that NOWPayments e-mails before each renewal (docs/1032). available is false while staff have the feature switched off or the processor login is not configured — the dashboard hides the choice then. Requires billing.payment.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
subscriptionId (path) | Uuid | Yes | The subscription whose crypto auto-renew choice is read or changed. |
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 · 429