# Add New Subscription

`POST /api/subscriptions/`



- **Group:** Subscriptions
- **Since:** v0.0.0
- **Authentication:** `authtoken` header, created under Setup > API > API Management
- **HTML version:** /apiguide/subscriptions/add-new-subscription/

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `authtoken` | String | **required** | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | String | **required** | New subscription name. |
| `description` | Text | **required** | Detailed description of the subscription. |
| `description_in_item` | TinyInt | **required** | Indicates if the description is included in the item (1 or 0). |
| `clientid` | Int | **required** | Client ID. |
| `date` | Date | **required** | Subscription start date (YYYY-MM-DD). |
| `terms` | Text | **required** | Subscription terms. |
| `currency` | Int | **required** | Currency ID. |
| `tax_id` | Int | **required** | Tax ID. |
| `stripe_tax_id_2` | Varchar | **required** | Stripe tax ID. |
| `stripe_plan_id` | Text | **required** | Stripe plan ID. |
| `stripe_subscription_id` | Text | **required** | Stripe Subscription ID. |
| `tax_id_2` | Int | **required** | Second tax ID. |
| `next_billing_cycle` | BigInt | **required** | Next billing cycle timestamp. |
| `ends_at` | BigInt | **required** | Subscription end timestamp. |
| `status` | Varchar | **required** | Subscription status (e.g., active). |
| `quantity` | Int | **required** | Subscription quantity. |
| `project_id` | Int | **required** | Associated project ID. |
| `hash` | Varchar | **required** | Unique hash identifier. |
| `created` | DateTime | **required** | Creation timestamp (YYYY-MM-DD HH:MM:SS). |
| `created_from` | Int | **required** | ID of the creator. |
| `date_subscribed` | DateTime | **required** | Subscription date (YYYY-MM-DD HH:MM:SS). |
| `in_test_environment` | Int | **required** | Indicates if the subscription is in a test environment (1 or 0). |
| `last_sent_at` | DateTime | **required** | Last sent timestamp (YYYY-MM-DD HH:MM:SS). |

## Example request

```bash
curl -X POST "https://yoursite.com/api/subscriptions/" \
  -H "authtoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "...", "description": "...", "description_in_item": "...", "clientid": "...", "date": "...", "terms": "...", "currency": "...", "tax_id": "...", "stripe_tax_id_2": "...", "stripe_plan_id": "...", "stripe_subscription_id": "...", "tax_id_2": "...", "next_billing_cycle": "...", "ends_at": "...", "status": "...", "quantity": "...", "project_id": "...", "hash": "...", "created": "...", "created_from": "...", "date_subscribed": "...", "in_test_environment": "...", "last_sent_at": "..." }'
```

## Success response

### Success-Response:

```json
HTTP/1.1 200 OK
{
    "status": true,
    "message": "Data Added Successfully"
}
```

## Error responses

### Error-Response:

```json
HTTP/1.1 400 Bad Request
{
    "status": false,
    "error": "Data not Added"
}
```

---

Perfex CRM REST API by Themesic Interactive. Full reference: /apiguide/