---
title: "Create a subscription"
method: POST
path: "/payment/{connection_id}/subscription"
tags: ["payment", "subscription"]
---

# Create a subscription

`POST /payment/{connection_id}/subscription`

## Path parameters

- `connection_id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- PaymentSubscription
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `description` string
  - `contact_id` string
  - `invoice_id` string
  - `current_period_end_at` string, date-time
  - `current_period_start_at` string, date-time
  - `canceled_at` string, date-time
  - `currency` string
  - `total_amount` number
  - `start_at` string, date-time
  - `end_at` string, date-time
  - `status` 'ACTIVE' | 'INACTIVE' | 'CANCELED' | 'PAUSED'
  - `month` number
  - `interval_unit` 'YEAR' | 'MONTH' | 'WEEK' | 'DAY'
  - `day_of_month` number
  - `day_of_week` number
  - `interval` number
  - `lineitems` PaymentLineitem[]
    - `id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `refunded_at` string, date-time
    - `total_amount` number
    - `refund_amount` number
    - `discount_amount` number
    - `tax_amount` number
    - `item_id` string
    - `unit_amount` number
    - `unit_quantity` number
    - `item_sku` string
    - `item_name` string
    - `item_description` string
    - `notes` string
    - `taxrate_id` string
    - `account_id` string
  - `raw` object

## Response `200`

Successful

- PaymentSubscription
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `description` string
  - `contact_id` string
  - `invoice_id` string
  - `current_period_end_at` string, date-time
  - `current_period_start_at` string, date-time
  - `canceled_at` string, date-time
  - `currency` string
  - `total_amount` number
  - `start_at` string, date-time
  - `end_at` string, date-time
  - `status` 'ACTIVE' | 'INACTIVE' | 'CANCELED' | 'PAUSED'
  - `month` number
  - `interval_unit` 'YEAR' | 'MONTH' | 'WEEK' | 'DAY'
  - `day_of_month` number
  - `day_of_week` number
  - `interval` number
  - `lineitems` PaymentLineitem[]
    - `id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `refunded_at` string, date-time
    - `total_amount` number
    - `refund_amount` number
    - `discount_amount` number
    - `tax_amount` number
    - `item_id` string
    - `unit_amount` number
    - `unit_quantity` number
    - `item_sku` string
    - `item_name` string
    - `item_description` string
    - `notes` string
    - `taxrate_id` string
    - `account_id` string
  - `raw` object

---

[API](https://skmtc.net/unified/apis/unified-to-api.md) · [All operations](https://skmtc.net/unified/apis/unified-to-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unified/unified-to-api/versions/1f72720916e4/schema)