Create a subscription

curl --request POST \
  --url https://api.assembly.com/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "collectionMethod": "sendInvoice",
  "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  "currency": "usd",
  "daysUntilDue": 30,
  "interval": "month",
  "intervalCount": 1,
  "lineItems": [
    {
      "amount": 5000,
      "description": "Onboarding setup fee",
      "id": "<string>",
      "priceId": "price_1a2b3c",
      "priceInterval": "month",
      "productId": "prod_1a2b3c",
      "quantity": 2,
      "type": "<string>"
    }
  ],
  "memo": "Monthly retainer",
  "paymentMethodPreferences": [
    {
      "feePaidByClient": true,
      "type": "creditCard"
    }
  ],
  "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "taxPercentage": 8.25,
  "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"
}
'

import requests

url = "https://api.assembly.com/v1/subscriptions"

payload = {
    "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "collectionMethod": "sendInvoice",
    "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "currency": "usd",
    "daysUntilDue": 30,
    "interval": "month",
    "intervalCount": 1,
    "lineItems": [
        {
            "amount": 5000,
            "description": "Onboarding setup fee",
            "id": "<string>",
            "priceId": "price_1a2b3c",
            "priceInterval": "month",
            "productId": "prod_1a2b3c",
            "quantity": 2,
            "type": "<string>"
        }
    ],
    "memo": "Monthly retainer",
    "paymentMethodPreferences": [
        {
            "feePaidByClient": True,
            "type": "creditCard"
        }
    ],
    "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "taxPercentage": 8.25,
    "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    collectionMethod: 'sendInvoice',
    companyId: 'f0e1d2c3-b4a5-6789-0123-456789abcdef',
    currency: 'usd',
    daysUntilDue: 30,
    interval: 'month',
    intervalCount: 1,
    lineItems: [
      {
        amount: 5000,
        description: 'Onboarding setup fee',
        id: '<string>',
        priceId: 'price_1a2b3c',
        priceInterval: 'month',
        productId: 'prod_1a2b3c',
        quantity: 2,
        type: '<string>'
      }
    ],
    memo: 'Monthly retainer',
    paymentMethodPreferences: [{feePaidByClient: true, type: 'creditCard'}],
    recipientId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    taxPercentage: 8.25,
    templateId: 'a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c'
  })
};

fetch('https://api.assembly.com/v1/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'collectionMethod' => 'sendInvoice',
    'companyId' => 'f0e1d2c3-b4a5-6789-0123-456789abcdef',
    'currency' => 'usd',
    'daysUntilDue' => 30,
    'interval' => 'month',
    'intervalCount' => 1,
    'lineItems' => [
        [
                'amount' => 5000,
                'description' => 'Onboarding setup fee',
                'id' => '<string>',
                'priceId' => 'price_1a2b3c',
                'priceInterval' => 'month',
                'productId' => 'prod_1a2b3c',
                'quantity' => 2,
                'type' => '<string>'
        ]
    ],
    'memo' => 'Monthly retainer',
    'paymentMethodPreferences' => [
        [
                'feePaidByClient' => true,
                'type' => 'creditCard'
        ]
    ],
    'recipientId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'taxPercentage' => 8.25,
    'templateId' => 'a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/subscriptions"

	payload := strings.NewReader("{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/subscriptions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}"

response = http.request(request)
puts response.read_body

{
  "additionalFields": {},
  "cancelledAt": "2024-02-20T14:05:00Z",
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "collectionMethod": "sendInvoice",
  "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  "createdAt": "<string>",
  "creatorId": "<string>",
  "currency": "usd",
  "data": "<string>",
  "daysUntilDue": 30,
  "fields": {
    "absorbTransactionFees": true,
    "address": {
      "addressLine1": "548 Market St",
      "addressLine2": "Suite 100",
      "city": "San Francisco",
      "country": "United States",
      "fullAddress": "548 Market St, San Francisco, CA 94105",
      "postalCode": "94105",
      "region": "California"
    },
    "allowPaymentViaACH": true,
    "allowPaymentViaCC": true,
    "attachment": "<string>",
    "cancelledAt": "<string>",
    "clientUserId": "<string>",
    "collectionMethod": "<string>",
    "companyId": "<string>",
    "currency": "<string>",
    "daysUntilDue": 123,
    "forcePaused": true,
    "interval": "<string>",
    "lineItems": [
      {
        "description": "<string>",
        "id": "<string>",
        "priceId": "<string>",
        "productId": "<string>",
        "quantity": 123,
        "rate": 123
      }
    ],
    "memo": "<string>",
    "paymentPreferences": {
      "absorbTransactionFee": [],
      "paymentMethodTypes": []
    },
    "prorate": true,
    "purchaseFields": {},
    "reactivatedBy": "<string>",
    "resetBillingCycle": true,
    "scheduleEndDate": 123,
    "scheduleIterations": 123,
    "scheduleStartDate": 123,
    "taxPercentage": 123
  },
  "filteredListIndexPkey": "<string>",
  "forcePaused": false,
  "id": "<string>",
  "identityId": "<string>",
  "interval": "monthly",
  "intervalCount": 1,
  "lineItems": [
    {
      "amount": 5000,
      "description": "Onboarding setup fee",
      "id": "<string>",
      "priceId": "price_1a2b3c",
      "priceInterval": "month",
      "productId": "prod_1a2b3c",
      "quantity": 2,
      "type": "<string>"
    }
  ],
  "memo": "Monthly retainer",
  "object": "<string>",
  "paymentMethodPreferences": [
    {
      "feePaidByClient": true,
      "type": "creditCard"
    }
  ],
  "paymentSourceId": "card_1a2b3c",
  "previousAttributes": {},
  "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "ref": "<string>",
  "status": "active",
  "taxPercentage": 8.25,
  "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c",
  "updatedAt": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

POST

subscriptions

Create a subscription

curl --request POST \
  --url https://api.assembly.com/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "collectionMethod": "sendInvoice",
  "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  "currency": "usd",
  "daysUntilDue": 30,
  "interval": "month",
  "intervalCount": 1,
  "lineItems": [
    {
      "amount": 5000,
      "description": "Onboarding setup fee",
      "id": "<string>",
      "priceId": "price_1a2b3c",
      "priceInterval": "month",
      "productId": "prod_1a2b3c",
      "quantity": 2,
      "type": "<string>"
    }
  ],
  "memo": "Monthly retainer",
  "paymentMethodPreferences": [
    {
      "feePaidByClient": true,
      "type": "creditCard"
    }
  ],
  "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "taxPercentage": 8.25,
  "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"
}
'

import requests

url = "https://api.assembly.com/v1/subscriptions"

payload = {
    "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "collectionMethod": "sendInvoice",
    "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "currency": "usd",
    "daysUntilDue": 30,
    "interval": "month",
    "intervalCount": 1,
    "lineItems": [
        {
            "amount": 5000,
            "description": "Onboarding setup fee",
            "id": "<string>",
            "priceId": "price_1a2b3c",
            "priceInterval": "month",
            "productId": "prod_1a2b3c",
            "quantity": 2,
            "type": "<string>"
        }
    ],
    "memo": "Monthly retainer",
    "paymentMethodPreferences": [
        {
            "feePaidByClient": True,
            "type": "creditCard"
        }
    ],
    "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "taxPercentage": 8.25,
    "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    collectionMethod: 'sendInvoice',
    companyId: 'f0e1d2c3-b4a5-6789-0123-456789abcdef',
    currency: 'usd',
    daysUntilDue: 30,
    interval: 'month',
    intervalCount: 1,
    lineItems: [
      {
        amount: 5000,
        description: 'Onboarding setup fee',
        id: '<string>',
        priceId: 'price_1a2b3c',
        priceInterval: 'month',
        productId: 'prod_1a2b3c',
        quantity: 2,
        type: '<string>'
      }
    ],
    memo: 'Monthly retainer',
    paymentMethodPreferences: [{feePaidByClient: true, type: 'creditCard'}],
    recipientId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    taxPercentage: 8.25,
    templateId: 'a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c'
  })
};

fetch('https://api.assembly.com/v1/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'collectionMethod' => 'sendInvoice',
    'companyId' => 'f0e1d2c3-b4a5-6789-0123-456789abcdef',
    'currency' => 'usd',
    'daysUntilDue' => 30,
    'interval' => 'month',
    'intervalCount' => 1,
    'lineItems' => [
        [
                'amount' => 5000,
                'description' => 'Onboarding setup fee',
                'id' => '<string>',
                'priceId' => 'price_1a2b3c',
                'priceInterval' => 'month',
                'productId' => 'prod_1a2b3c',
                'quantity' => 2,
                'type' => '<string>'
        ]
    ],
    'memo' => 'Monthly retainer',
    'paymentMethodPreferences' => [
        [
                'feePaidByClient' => true,
                'type' => 'creditCard'
        ]
    ],
    'recipientId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'taxPercentage' => 8.25,
    'templateId' => 'a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/subscriptions"

	payload := strings.NewReader("{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/subscriptions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"collectionMethod\": \"sendInvoice\",\n  \"companyId\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n  \"currency\": \"usd\",\n  \"daysUntilDue\": 30,\n  \"interval\": \"month\",\n  \"intervalCount\": 1,\n  \"lineItems\": [\n    {\n      \"amount\": 5000,\n      \"description\": \"Onboarding setup fee\",\n      \"id\": \"<string>\",\n      \"priceId\": \"price_1a2b3c\",\n      \"priceInterval\": \"month\",\n      \"productId\": \"prod_1a2b3c\",\n      \"quantity\": 2,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"memo\": \"Monthly retainer\",\n  \"paymentMethodPreferences\": [\n    {\n      \"feePaidByClient\": true,\n      \"type\": \"creditCard\"\n    }\n  ],\n  \"recipientId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"taxPercentage\": 8.25,\n  \"templateId\": \"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c\"\n}"

response = http.request(request)
puts response.read_body

{
  "additionalFields": {},
  "cancelledAt": "2024-02-20T14:05:00Z",
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "collectionMethod": "sendInvoice",
  "companyId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  "createdAt": "<string>",
  "creatorId": "<string>",
  "currency": "usd",
  "data": "<string>",
  "daysUntilDue": 30,
  "fields": {
    "absorbTransactionFees": true,
    "address": {
      "addressLine1": "548 Market St",
      "addressLine2": "Suite 100",
      "city": "San Francisco",
      "country": "United States",
      "fullAddress": "548 Market St, San Francisco, CA 94105",
      "postalCode": "94105",
      "region": "California"
    },
    "allowPaymentViaACH": true,
    "allowPaymentViaCC": true,
    "attachment": "<string>",
    "cancelledAt": "<string>",
    "clientUserId": "<string>",
    "collectionMethod": "<string>",
    "companyId": "<string>",
    "currency": "<string>",
    "daysUntilDue": 123,
    "forcePaused": true,
    "interval": "<string>",
    "lineItems": [
      {
        "description": "<string>",
        "id": "<string>",
        "priceId": "<string>",
        "productId": "<string>",
        "quantity": 123,
        "rate": 123
      }
    ],
    "memo": "<string>",
    "paymentPreferences": {
      "absorbTransactionFee": [],
      "paymentMethodTypes": []
    },
    "prorate": true,
    "purchaseFields": {},
    "reactivatedBy": "<string>",
    "resetBillingCycle": true,
    "scheduleEndDate": 123,
    "scheduleIterations": 123,
    "scheduleStartDate": 123,
    "taxPercentage": 123
  },
  "filteredListIndexPkey": "<string>",
  "forcePaused": false,
  "id": "<string>",
  "identityId": "<string>",
  "interval": "monthly",
  "intervalCount": 1,
  "lineItems": [
    {
      "amount": 5000,
      "description": "Onboarding setup fee",
      "id": "<string>",
      "priceId": "price_1a2b3c",
      "priceInterval": "month",
      "productId": "prod_1a2b3c",
      "quantity": 2,
      "type": "<string>"
    }
  ],
  "memo": "Monthly retainer",
  "object": "<string>",
  "paymentMethodPreferences": [
    {
      "feePaidByClient": true,
      "type": "creditCard"
    }
  ],
  "paymentSourceId": "card_1a2b3c",
  "previousAttributes": {},
  "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "ref": "<string>",
  "status": "active",
  "taxPercentage": 8.25,
  "templateId": "a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c",
  "updatedAt": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Subscription to create

clientId

string

ClientID is the client the subscription bills. Exactly one of clientId, companyId, or recipientId must be provided.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

collectionMethod

enum<string>

CollectionMethod is how invoices for the subscription are collected.

Available options:

sendInvoice,

chargeAutomatically

Example:

"sendInvoice"

companyId

string

CompanyID is the company the subscription bills. Exactly one of clientId, companyId, or recipientId must be provided.

Example:

"f0e1d2c3-b4a5-6789-0123-456789abcdef"

currency

string

Currency is the ISO currency code.

Example:

"usd"

daysUntilDue

integer

DaysUntilDue sets the invoice due date relative to issuance.

Example:

30

interval

enum<string>

Interval is the billing period.

Available options:

day,

week,

month,

quarterly,

biannually,

year,

semiannually

Example:

"month"

intervalCount

integer

IntervalCount is the number of intervals between billings.

Example:

1

lineItems

object[]

LineItems are the subscription line items. Required unless templateId is provided, in which case the template's line items are used when omitted. Must contain at least one item when provided.

Minimum array length: 1

Show child attributes

memo

string

Memo is an optional note shown on generated invoices.

Example:

"Monthly retainer"

paymentMethodPreferences

object[]

PaymentMethodPreferences restricts which payment methods are offered.

Show child attributes

recipientId

string

RecipientID is the recipient (client or company) of the subscription. Exactly one of clientId, companyId, or recipientId must be provided.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

taxPercentage

number

TaxPercentage is an optional tax rate applied to generated invoices.

Example:

8.25

templateId

string

TemplateID optionally seeds the subscription from a subscription template.

Example:

"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"

Response

additionalFields

object

StripeObject would hold field from stripe's subscription or subscription schedule object

cancelledAt

string<date-time>

CancelledAt is the RFC 3339 timestamp at which the subscription was cancelled; absent while active.

Example:

"2024-02-20T14:05:00Z"

clientId

string

ClientID is the ID of the client user the subscription bills.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

collectionMethod

enum<string>

CollectionMethod determines how the subscription's invoices are collected.

Available options:

sendInvoice,

chargeAutomatically

Example:

"sendInvoice"

companyId

string

CompanyID is the ID of the company the subscription bills.

Example:

"f0e1d2c3-b4a5-6789-0123-456789abcdef"

createdAt

string

creatorId

string

currency

string

Currency is the ISO 4217 currency code the subscription is billed in.

Example:

"usd"

data

string

daysUntilDue

integer

DaysUntilDue is the number of days a recipient has to pay an invoice when collected by sending an invoice.

Example:

30

fields

object

Show child attributes

filteredListIndexPkey

string

{client_id}/INBOX_NOTIFICATION

forcePaused

boolean

ForcePaused indicates the subscription was paused because the workspace plan lapsed.

Example:

false

string

identityId

string

interval

enum<string>

Interval is the billing period the subscription recurs on.

Available options:

day,

week,

month,

quarterly,

biannually,

year,

semiannually

Example:

"monthly"

intervalCount

integer

IntervalCount is the number of intervals between each billing cycle.

Example:

1

lineItems

object[]

LineItems are the products and ad-hoc charges billed on each cycle.

Show child attributes

memo

string

Memo is an optional note shown to the recipient on generated invoices.

Example:

"Monthly retainer"

object

string

paymentMethodPreferences

object[]

field is only used for platform api and should not be used anywhere else on FE/BE

Show child attributes

paymentSourceId

string

PaymentSourceId is the ID of the saved payment source charged for automatically-collected subscriptions.

Example:

"card_1a2b3c"

previousAttributes

object

recipientId

string

RecipientID is the ID of the client or company the subscription bills. Deprecated: use ClientID and CompanyID instead

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

ref

string

status

string

Status is the current lifecycle status of the subscription, mirrored from Stripe.

Example:

"active"

taxPercentage

number | null

TaxPercentage is the tax rate applied to the subscription, as a percentage.

Example:

8.25

templateId

string

TemplateID is the ID of the subscription template the subscription was created from, when applicable.

Example:

"a7c3e9f1-2b4d-4e6a-8c0f-1d2e3f4a5b6c"

updatedAt

string

Subscriptions List subscriptions

⌘I

Getting started

Webhooks

Core Resources

CRM

Messaging

Billing

Files

Contracts

Forms

Tasks

Token

Others

Create a subscription

Authorizations

Body

Response