Create subscription

POST

/api/v1/subscriptions

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "name": "example", "line_items": [ { "item_id": "example", "description": "example", "quantity": 1, "unit_price": 1, "tax_percent": 1, "total": 1 } ], "interval": "weekly", "currency": "USD", "start_date": "2026-04-15T12:00:00Z", "end_date": "2026-04-15T12:00:00Z", "notes": "example", "discount_percent": 1, "tax_percent": 1, "auto_generate_invoice": true }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

lead_id

required

string

/^[0-9a-fA-F]{24}$/

name

required

string

>= 1 characters <= 500 characters

line_items

required

Array<object>

>= 1 items

object

item_id

string

/^[0-9a-fA-F]{24}$/

description

required

string

>= 1 characters <= 1000 characters

quantity

required

number

unit_price

required

number

tax_percent

number

<= 100

total

required

number

interval

required

string

Allowed values: weekly monthly quarterly semi_annual annual

currency

string

default: USD >= 1 characters <= 3 characters

start_date

required

string format: date-time

end_date

Any of:

string

string format: date-time

null

null

notes

Any of:

string

string

<= 5000 characters

null

null

discount_percent

number

<= 100

tax_percent

number

<= 100

auto_generate_invoice

boolean

default: true

Responses

201

Created

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}