API ReferenceBilling
Restart the free trial
POST /rest/v1/billing/restart_trial
Free, no link needed. Available only to canceled stores that never restarted a trial and never paid, or whose last paid period ended more than 3 months ago (trial_not_available otherwise). Returns the updated billing. Requires billing:manage.
Authorization
apiKey AuthorizationBearer <token>
Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.
In: header
Header Parameters
Idempotency-Key?string
Unique client-generated key (max 255 chars), stored 24h.
Length
length <= 255Response Body
application/json
application/json
curl -X POST "https://example.com/billing/restart_trial"{ "object": "billing", "billing_source": "stripe", "managed_elsewhere": null, "plan": { "key": "pro", "name": "Pro", "interval": "month" }, "status": "trialing", "trial": true, "current_period_end": "2019-08-24T14:15:22Z", "cancel_at_period_end": true, "payment_method": { "brand": "visa", "last4": "4242" }, "usage": { "products": 0, "max_accounts_on_one_channel": 0, "team_members": 0 }, "plans": [ { "key": "basic", "name": "Enterprise", "limits": { "products": 5000, "accounts_per_channel": 4, "team_members": 1, "running_promotions": 1 }, "prices": { "month": { "amount": 79, "currency": "usd", "selectable": true, "reason": "string" }, "year": { "amount": 79, "currency": "usd", "selectable": true, "reason": "string" } } } ], "invoices": [ { "amount": "49.00", "status": "paid", "url": "http://example.com", "created_at": "2019-08-24T14:15:22Z" } ], "actions": { "change_plan": true, "update_payment_method": true, "cancel": true, "manage": true }}Last updated on October 15, 2026
Need help?
Email us and a human replies, usually within one business day.