---
title: "Start"
method: POST
path: "/api/v1/billing/start"
tags: ["billing"]
---

# Start

`POST /api/v1/billing/start`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/billing/start`
- Auth: HTTP bearer

## Request body

- StartSubscriptionRequest
  - `plan` string, required

## Response `200`

Successful Response

- BillingSummary
  - `subscription_plan` string, nullable, required
  - `guarantee_status` string, required
  - `pilot_start_at` string, date-time, nullable, required
  - `billing_cycle_start` string, date-time, nullable, required
  - `next_cycle_at` string, date-time, nullable, required
  - `paused_days_client` integer, required
  - `paused_days_system` integer, required
  - `credits_balance` integer
  - `credits_included` integer
  - `credits_used_this_cycle` integer
  - `has_stripe_subscription` boolean
  - `plan_comped` boolean
  - `pilot_expires_at` string, date-time, nullable
  - `plan_active` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/nudgelink/apis/nudgelink-api.md) · [All operations](https://skmtc.dev/nudgelink/apis/nudgelink-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nudgelink/apis/nudgelink-api/revisions/baa46e6db986?raw)