Subscriptions API reference

Every endpoint in Subscriptions: 158 operations across 41 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.

Products

GET`/api/subscriptions/products`

List products, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/subscriptions/products 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}`

Read one product in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/comments`

List the comments for a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/dependencies`

List what would break if a product were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/email-check`

List the email check for a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/related`

List the related for a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/related/{module}`

List the related for a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/similar`

Find products that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/{id}/timeline`

Read everything that has happened to a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/export.csv`

Download products as a CSV file

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/kanban`

Read products arranged as a board

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/products/pivot`

Summarise products as a pivot table

curl -X GET https://app.jaicrm.ai/api/subscriptions/products/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products`

Create a product

Body

Field	Type	Required	Notes
`name`	string	Required	at most 200 characters
`code`	string	Optional	at most 60 characters
`description`	string	Optional	None
`isActive`	boolean	Optional	None
`custom`	object	Optional	None

curl -X POST https://app.jaicrm.ai/api/subscriptions/products 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "code": "…",
    "description": "…",
    "isActive": true
  }'

POST`/api/subscriptions/products/{id}/assignees`

Put somebody on a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/{id}/comments`

Add to the comments of a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/{id}/email`

Send an email about a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/{id}/notes`

Add a note to a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/bulk`

Change several products at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/bulk/assign`

Assign several products to somebody at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/bulk/delete`

Delete several products at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/products/import`

Import products from a CSV file

curl -X POST https://app.jaicrm.ai/api/subscriptions/products/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/products/{id}`

Change a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`name`	string	Optional	at most 200 characters
`code`	string	Optional	at most 60 characters
`description`	string	Optional	None
`isActive`	boolean	Optional	None
`custom`	object	Optional	None

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "code": "…",
    "description": "…",
    "isActive": true
  }'

PATCH`/api/subscriptions/products/{id}/notes/{noteId}`

Change or remove a note on a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/products/{id}`

Delete a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/products/{id}/assignees/{userId}`

Take somebody off a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/products/{id}/comments/{commentId}`

Remove from the comments of a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/products/{id}/notes/{noteId}`

Change or remove a note on a product

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/products/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Plans

GET`/api/subscriptions/plans`

List plans, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}`

Read one plan in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/comments`

List the comments for a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/dependencies`

List what would break if a plan were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/email-check`

List the email check for a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/related`

List the related for a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/related/{module}`

List the related for a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/similar`

Find plans that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/{id}/timeline`

Read everything that has happened to a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/export.csv`

Download plans as a CSV file

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/kanban`

Read plans arranged as a board

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/plans/pivot`

Summarise plans as a pivot table

curl -X GET https://app.jaicrm.ai/api/subscriptions/plans/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans`

Create a plan

Body

Field	Type	Required	Notes
`code`	string	Required	at most 60 characters
`name`	string	Required	at most 200 characters
`description`	string	Optional	None
`productId`	string (uuid)	Optional	None
`itemId`	string (uuid)	Optional	None
`price`	number	Required	0 or more
`currency`	string	Optional	at most 3 characters
`interval`	string	Required	one of `weekly`, `fortnightly`, `monthly`, `quarterly`, `half_yearly`, `yearly`, `days`
`everyDays`	integer	Optional	1 or more
`trialDays`	integer	Optional	0 or more
`setupFee`	number	Optional	0 or more
`taxRateId`	string (uuid)	Optional	None
`gstRate`	number	Optional	0 or more
`hsnSac`	string	Optional	at most 20 characters
`defaultCycles`	integer	Optional	1 or more
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "description": "…",
    "productId": "…"
  }'

POST`/api/subscriptions/plans/{id}/assignees`

Put somebody on a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/{id}/comments`

Add to the comments of a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/{id}/email`

Send an email about a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/{id}/notes`

Add a note to a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/bulk`

Change several plans at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/bulk/assign`

Assign several plans to somebody at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/bulk/delete`

Delete several plans at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/plans/import`

Import plans from a CSV file

curl -X POST https://app.jaicrm.ai/api/subscriptions/plans/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/plans/{id}`

Change a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`code`	string	Optional	at most 60 characters
`name`	string	Optional	at most 200 characters
`description`	string	Optional	None
`productId`	string (uuid)	Optional	None
`itemId`	string (uuid)	Optional	None
`price`	number	Optional	0 or more
`currency`	string	Optional	at most 3 characters
`interval`	string	Optional	one of `weekly`, `fortnightly`, `monthly`, `quarterly`, `half_yearly`, `yearly`, `days`
`everyDays`	integer	Optional	1 or more
`trialDays`	integer	Optional	0 or more
`setupFee`	number	Optional	0 or more
`taxRateId`	string (uuid)	Optional	None
`gstRate`	number	Optional	0 or more
`hsnSac`	string	Optional	at most 20 characters
`defaultCycles`	integer	Optional	1 or more
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "description": "…",
    "productId": "…"
  }'

PATCH`/api/subscriptions/plans/{id}/notes/{noteId}`

Change or remove a note on a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/plans/{id}`

Delete a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/plans/{id}/assignees/{userId}`

Take somebody off a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/plans/{id}/comments/{commentId}`

Remove from the comments of a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/plans/{id}/notes/{noteId}`

Change or remove a note on a plan

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/plans/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Addons

GET`/api/subscriptions/addons`

List addons, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}`

Read one addon in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/comments`

List the comments for an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/dependencies`

List what would break if an addon were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/email-check`

List the email check for an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/related`

List the related for an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/related/{module}`

List the related for an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/similar`

Find addons that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/{id}/timeline`

Read everything that has happened to an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/export.csv`

Download addons as a CSV file

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/kanban`

Read addons arranged as a board

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/addons/pivot`

Summarise addons as a pivot table

curl -X GET https://app.jaicrm.ai/api/subscriptions/addons/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons`

Create an addon

Body

Field	Type	Required	Notes
`code`	string	Required	at most 60 characters
`name`	string	Required	at most 200 characters
`description`	string	Optional	None
`itemId`	string (uuid)	Optional	None
`price`	number	Required	0 or more
`currency`	string	Optional	at most 3 characters
`kind`	string	Optional	one of `recurring`, `one_time`
`pricingModel`	string	Optional	one of `unit`, `usage`
`unitName`	string	Optional	at most 40 characters
`taxRateId`	string (uuid)	Optional	None
`gstRate`	number	Optional	0 or more
`hsnSac`	string	Optional	at most 20 characters
`planCodes`	array	Optional	None
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "description": "…",
    "itemId": "…"
  }'

POST`/api/subscriptions/addons/{id}/assignees`

Put somebody on an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/{id}/comments`

Add to the comments of an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/{id}/email`

Send an email about an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/{id}/notes`

Add a note to an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/bulk`

Change several addons at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/bulk/assign`

Assign several addons to somebody at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/bulk/delete`

Delete several addons at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/addons/import`

Import addons from a CSV file

curl -X POST https://app.jaicrm.ai/api/subscriptions/addons/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/addons/{id}`

Change an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`code`	string	Optional	at most 60 characters
`name`	string	Optional	at most 200 characters
`description`	string	Optional	None
`itemId`	string (uuid)	Optional	None
`price`	number	Optional	0 or more
`currency`	string	Optional	at most 3 characters
`kind`	string	Optional	one of `recurring`, `one_time`
`pricingModel`	string	Optional	one of `unit`, `usage`
`unitName`	string	Optional	at most 40 characters
`taxRateId`	string (uuid)	Optional	None
`gstRate`	number	Optional	0 or more
`hsnSac`	string	Optional	at most 20 characters
`planCodes`	array	Optional	None
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "description": "…",
    "itemId": "…"
  }'

PATCH`/api/subscriptions/addons/{id}/notes/{noteId}`

Change or remove a note on an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/addons/{id}`

Delete an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/addons/{id}/assignees/{userId}`

Take somebody off an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/addons/{id}/comments/{commentId}`

Remove from the comments of an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/addons/{id}/notes/{noteId}`

Change or remove a note on an addon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/addons/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Coupons

GET`/api/subscriptions/coupons`

List coupons, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}`

Read one coupon in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/comments`

List the comments for a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/dependencies`

List what would break if a coupon were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/email-check`

List the email check for a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/related`

List the related for a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/related/{module}`

List the related for a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/similar`

Find coupons that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/{id}/timeline`

Read everything that has happened to a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/export.csv`

Download coupons as a CSV file

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/kanban`

Read coupons arranged as a board

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/coupons/pivot`

Summarise coupons as a pivot table

curl -X GET https://app.jaicrm.ai/api/subscriptions/coupons/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons`

Create a coupon

Body

Field	Type	Required	Notes
`code`	string	Required	at most 60 characters
`name`	string	Required	at most 200 characters
`discountType`	string	Optional	one of `percent`, `flat`
`discountValue`	number	Required	0 or more
`duration`	string	Optional	one of `once`, `forever`, `cycles`
`durationCycles`	integer	Optional	1 or more
`maxRedemptions`	integer	Optional	1 or more
`startsOn`	one of several	Optional	None
`expiresOn`	one of several	Optional	None
`planCodes`	array	Optional	None
`addonCodes`	array	Optional	None
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "discountType": "percent",
    "discountValue": 0
  }'

POST`/api/subscriptions/coupons/{id}/assignees`

Put somebody on a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/{id}/comments`

Add to the comments of a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/{id}/email`

Send an email about a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/{id}/notes`

Add a note to a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/bulk`

Change several coupons at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/bulk/assign`

Assign several coupons to somebody at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/bulk/delete`

Delete several coupons at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/coupons/import`

Import coupons from a CSV file

curl -X POST https://app.jaicrm.ai/api/subscriptions/coupons/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/coupons/{id}`

Change a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`code`	string	Optional	at most 60 characters
`name`	string	Optional	at most 200 characters
`discountType`	string	Optional	one of `percent`, `flat`
`discountValue`	number	Optional	0 or more
`duration`	string	Optional	one of `once`, `forever`, `cycles`
`durationCycles`	integer	Optional	1 or more
`maxRedemptions`	integer	Optional	1 or more
`startsOn`	one of several	Optional	None
`expiresOn`	one of several	Optional	None
`planCodes`	array	Optional	None
`addonCodes`	array	Optional	None
`isActive`	boolean	Optional	None
`notes`	string	Optional	None
`custom`	object	Optional	None

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "code": "…",
    "name": "…",
    "discountType": "percent",
    "discountValue": 0
  }'

PATCH`/api/subscriptions/coupons/{id}/notes/{noteId}`

Change or remove a note on a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/coupons/{id}`

Delete a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/coupons/{id}/assignees/{userId}`

Take somebody off a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/coupons/{id}/comments/{commentId}`

Remove from the comments of a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/coupons/{id}/notes/{noteId}`

Change or remove a note on a coupon

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/coupons/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Subscriptions

GET`/api/subscriptions`

List subscriptions, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/subscriptions 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/{id}`

Read one subscription in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions`

Create a subscription

Body

Field	Type	Required	Notes
`name`	string	Optional	at most 200 characters
`customerId`	string (uuid)	Required	None
`contactId`	string (uuid)	Optional	None
`referenceNumber`	string	Optional	at most 120 characters
`salesPersonId`	string (uuid)	Optional	None
`ownerId`	string (uuid)	Optional	None
`paymentMode`	string	Optional	one of `online`, `offline`
`autocharge`	boolean	Optional	None
`invoicePreference`	string	Optional	one of `send`, `draft`
`dueDays`	integer	Optional	0 or more
`prorate`	boolean	Optional	None
`advanceBillingDays`	integer	Optional	0 or more
`creditPausedDays`	boolean	Optional	None
`renewalPricing`	string	Optional	one of `retain`, `latest`, `markup`, `markdown`
`renewalPercent`	number	Optional	0 or more
`renewalEveryCycles`	integer	Optional	1 or more
`notes`	string	Optional	None
`tags`	array	Optional	None
`custom`	object	Optional	None
`startsOn`	one of several	Optional	None
`interval`	string	Optional	one of `weekly`, `fortnightly`, `monthly`, `quarterly`, `half_yearly`, `yearly`, `days`
`maxCycles`	integer	Optional	1 or more

curl -X POST https://app.jaicrm.ai/api/subscriptions 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "customerId": "…",
    "contactId": "…",
    "referenceNumber": "…"
  }'

PATCH`/api/subscriptions/{id}`

Change a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`name`	string	Optional	at most 200 characters
`customerId`	string (uuid)	Optional	None
`contactId`	string (uuid)	Optional	None
`referenceNumber`	string	Optional	at most 120 characters
`salesPersonId`	string (uuid)	Optional	None
`ownerId`	string (uuid)	Optional	None
`paymentMode`	string	Optional	one of `online`, `offline`
`autocharge`	boolean	Optional	None
`invoicePreference`	string	Optional	one of `send`, `draft`
`dueDays`	integer	Optional	0 or more
`prorate`	boolean	Optional	None
`advanceBillingDays`	integer	Optional	0 or more
`creditPausedDays`	boolean	Optional	None
`renewalPricing`	string	Optional	one of `retain`, `latest`, `markup`, `markdown`
`renewalPercent`	number	Optional	0 or more
`renewalEveryCycles`	integer	Optional	1 or more
`notes`	string	Optional	None
`tags`	array	Optional	None
`custom`	object	Optional	None
`startsOn`	one of several	Optional	None
`interval`	string	Optional	one of `weekly`, `fortnightly`, `monthly`, `quarterly`, `half_yearly`, `yearly`, `days`
`maxCycles`	integer	Optional	1 or more

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "customerId": "…",
    "contactId": "…",
    "referenceNumber": "…"
  }'

DELETE`/api/subscriptions/{id}`

Delete a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Comments

GET`/api/subscriptions/{id}/comments`

List the comments for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/{id}/comments`

Add to the comments of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/{id}/comments/{commentId}`

Remove from the comments of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Bulk

POST`/api/subscriptions/bulk`

Change several subscriptions at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/bulk/assign`

Assign several subscriptions to somebody at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/subscriptions/bulk/delete`

Delete several subscriptions at once

curl -X POST https://app.jaicrm.ai/api/subscriptions/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

Notes

POST`/api/subscriptions/{id}/notes`

Add a note to a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/{id}/notes/{noteId}`

Change or remove a note on a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/{id}/notes/{noteId}`

Change or remove a note on a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Preferences

GET`/api/subscriptions/preferences`

List the preferences for a subscription

curl -X GET https://app.jaicrm.ai/api/subscriptions/preferences 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/subscriptions/preferences`

Change the preferences of a subscription

curl -X PATCH https://app.jaicrm.ai/api/subscriptions/preferences 
  -H 'Authorization: Bearer YOUR_API_KEY'

Assignees

POST`/api/subscriptions/{id}/assignees`

Put somebody on a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/subscriptions/{id}/assignees/{userId}`

Take somebody off a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/{id}/related`

List the related for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/subscriptions/{id}/related/{module}`

List the related for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Revenue

GET`/api/subscriptions/revenue`

List the revenue for a subscription

curl -X GET https://app.jaicrm.ai/api/subscriptions/revenue 
  -H 'Authorization: Bearer YOUR_API_KEY'

Renewals

GET`/api/subscriptions/renewals`

List the renewals for a subscription

curl -X GET https://app.jaicrm.ai/api/subscriptions/renewals 
  -H 'Authorization: Bearer YOUR_API_KEY'

Preview

POST`/api/subscriptions/preview`

Add to the preview of a subscription

curl -X POST https://app.jaicrm.ai/api/subscriptions/preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

New

POST`/api/subscriptions/new`

Add to the new of a subscription

curl -X POST https://app.jaicrm.ai/api/subscriptions/new 
  -H 'Authorization: Bearer YOUR_API_KEY'

Change

POST`/api/subscriptions/{id}/change`

Add to the change of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/change 
  -H 'Authorization: Bearer YOUR_API_KEY'

Pause

POST`/api/subscriptions/{id}/pause`

Add to the pause of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/pause 
  -H 'Authorization: Bearer YOUR_API_KEY'

Resume

POST`/api/subscriptions/{id}/resume`

Add to the resume of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/resume 
  -H 'Authorization: Bearer YOUR_API_KEY'

Schedule

DELETE`/api/subscriptions/{id}/schedule`

Remove from the schedule of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/schedule 
  -H 'Authorization: Bearer YOUR_API_KEY'

Cancel

POST`/api/subscriptions/{id}/cancel`

Cancel a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/cancel 
  -H 'Authorization: Bearer YOUR_API_KEY'

Reactivate

POST`/api/subscriptions/{id}/reactivate`

Add to the reactivate of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/reactivate 
  -H 'Authorization: Bearer YOUR_API_KEY'

Extend

POST`/api/subscriptions/{id}/extend`

Add to the extend of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/extend 
  -H 'Authorization: Bearer YOUR_API_KEY'

Next billing

POST`/api/subscriptions/{id}/next-billing`

Add to the next billing of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/next-billing 
  -H 'Authorization: Bearer YOUR_API_KEY'

Charge

POST`/api/subscriptions/{id}/charge`

Add to the charge of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/charge 
  -H 'Authorization: Bearer YOUR_API_KEY'

Addon

POST`/api/subscriptions/{id}/addon`

Add to the addon of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/addon 
  -H 'Authorization: Bearer YOUR_API_KEY'

Lines

DELETE`/api/subscriptions/{id}/lines/{lineId}`

Remove from the lines of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`lineId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/lines/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Coupon

POST`/api/subscriptions/{id}/coupon`

Add to the coupon of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/coupon 
  -H 'Authorization: Bearer YOUR_API_KEY'

Bill now

POST`/api/subscriptions/{id}/bill-now`

Add to the bill now of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/bill-now 
  -H 'Authorization: Bearer YOUR_API_KEY'

Record payment

POST`/api/subscriptions/{id}/record-payment`

Add to the record payment of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/record-payment 
  -H 'Authorization: Bearer YOUR_API_KEY'

Changes

DELETE`/api/subscriptions/{id}/changes/{changeId}`

Remove from the changes of a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`changeId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/subscriptions/RECORD_ID/changes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Export.csv

GET`/api/subscriptions/export.csv`

Download subscriptions as a CSV file

curl -X GET https://app.jaicrm.ai/api/subscriptions/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

Kanban

GET`/api/subscriptions/kanban`

Read subscriptions arranged as a board

curl -X GET https://app.jaicrm.ai/api/subscriptions/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

Pivot

GET`/api/subscriptions/pivot`

Summarise subscriptions as a pivot table

curl -X GET https://app.jaicrm.ai/api/subscriptions/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

Import

POST`/api/subscriptions/import`

Import subscriptions from a CSV file

curl -X POST https://app.jaicrm.ai/api/subscriptions/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

Similar

GET`/api/subscriptions/{id}/similar`

Find subscriptions that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

Dependencies

GET`/api/subscriptions/{id}/dependencies`

List what would break if a subscription were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

Timeline

GET`/api/subscriptions/{id}/timeline`

Read everything that has happened to a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

Email check

GET`/api/subscriptions/{id}/email-check`

List the email check for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

Email

POST`/api/subscriptions/{id}/email`

Send an email about a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/subscriptions/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

Overview

GET`/api/subscriptions/{id}/overview`

List the overview for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/RECORD_ID/overview 
  -H 'Authorization: Bearer YOUR_API_KEY'

For customer

GET`/api/subscriptions/for-customer/{id}`

List the for customer for a subscription

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/subscriptions/for-customer/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Next in api Accounting & finance endpoints → Authentication endpoints →

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.

Subscriptions endpoints

Products

GET/api/subscriptions/products

GET/api/subscriptions/products/{id}

GET/api/subscriptions/products/{id}/comments

GET/api/subscriptions/products/{id}/dependencies

GET/api/subscriptions/products/{id}/email-check

GET/api/subscriptions/products/{id}/related

GET/api/subscriptions/products/{id}/related/{module}

GET/api/subscriptions/products/{id}/similar

GET/api/subscriptions/products/{id}/timeline

GET/api/subscriptions/products/export.csv

GET/api/subscriptions/products/kanban

GET/api/subscriptions/products/pivot

POST/api/subscriptions/products

POST/api/subscriptions/products/{id}/assignees

POST/api/subscriptions/products/{id}/comments

POST/api/subscriptions/products/{id}/email

POST/api/subscriptions/products/{id}/notes

POST/api/subscriptions/products/bulk

POST/api/subscriptions/products/bulk/assign

POST/api/subscriptions/products/bulk/delete

POST/api/subscriptions/products/import

PATCH/api/subscriptions/products/{id}

PATCH/api/subscriptions/products/{id}/notes/{noteId}

DELETE/api/subscriptions/products/{id}

DELETE/api/subscriptions/products/{id}/assignees/{userId}

DELETE/api/subscriptions/products/{id}/comments/{commentId}

DELETE/api/subscriptions/products/{id}/notes/{noteId}

Plans

GET/api/subscriptions/plans

GET/api/subscriptions/plans/{id}

GET/api/subscriptions/plans/{id}/comments

GET/api/subscriptions/plans/{id}/dependencies

GET/api/subscriptions/plans/{id}/email-check

GET/api/subscriptions/plans/{id}/related

GET/api/subscriptions/plans/{id}/related/{module}

GET/api/subscriptions/plans/{id}/similar

GET/api/subscriptions/plans/{id}/timeline

GET/api/subscriptions/plans/export.csv

GET/api/subscriptions/plans/kanban

GET/api/subscriptions/plans/pivot

POST/api/subscriptions/plans

POST/api/subscriptions/plans/{id}/assignees

POST/api/subscriptions/plans/{id}/comments

POST/api/subscriptions/plans/{id}/email

POST/api/subscriptions/plans/{id}/notes

POST/api/subscriptions/plans/bulk

POST/api/subscriptions/plans/bulk/assign

POST/api/subscriptions/plans/bulk/delete

POST/api/subscriptions/plans/import

PATCH/api/subscriptions/plans/{id}

PATCH/api/subscriptions/plans/{id}/notes/{noteId}

DELETE/api/subscriptions/plans/{id}

DELETE/api/subscriptions/plans/{id}/assignees/{userId}

DELETE/api/subscriptions/plans/{id}/comments/{commentId}

DELETE/api/subscriptions/plans/{id}/notes/{noteId}

Addons

GET/api/subscriptions/addons

GET/api/subscriptions/addons/{id}

GET/api/subscriptions/addons/{id}/comments

GET/api/subscriptions/addons/{id}/dependencies

GET/api/subscriptions/addons/{id}/email-check

GET/api/subscriptions/addons/{id}/related

GET/api/subscriptions/addons/{id}/related/{module}

GET/api/subscriptions/addons/{id}/similar

GET/api/subscriptions/addons/{id}/timeline

GET/api/subscriptions/addons/export.csv

GET/api/subscriptions/addons/kanban

GET/api/subscriptions/addons/pivot

POST/api/subscriptions/addons

POST/api/subscriptions/addons/{id}/assignees

POST/api/subscriptions/addons/{id}/comments

POST/api/subscriptions/addons/{id}/email

POST/api/subscriptions/addons/{id}/notes

POST/api/subscriptions/addons/bulk

POST/api/subscriptions/addons/bulk/assign

POST/api/subscriptions/addons/bulk/delete

POST/api/subscriptions/addons/import

PATCH/api/subscriptions/addons/{id}

GET`/api/subscriptions/products`

GET`/api/subscriptions/products/{id}`

GET`/api/subscriptions/products/{id}/comments`

GET`/api/subscriptions/products/{id}/dependencies`

GET`/api/subscriptions/products/{id}/email-check`

GET`/api/subscriptions/products/{id}/related`

GET`/api/subscriptions/products/{id}/related/{module}`

GET`/api/subscriptions/products/{id}/similar`

GET`/api/subscriptions/products/{id}/timeline`

GET`/api/subscriptions/products/export.csv`

GET`/api/subscriptions/products/kanban`

GET`/api/subscriptions/products/pivot`

POST`/api/subscriptions/products`

POST`/api/subscriptions/products/{id}/assignees`

POST`/api/subscriptions/products/{id}/comments`

POST`/api/subscriptions/products/{id}/email`

POST`/api/subscriptions/products/{id}/notes`

POST`/api/subscriptions/products/bulk`

POST`/api/subscriptions/products/bulk/assign`

POST`/api/subscriptions/products/bulk/delete`

POST`/api/subscriptions/products/import`

PATCH`/api/subscriptions/products/{id}`

PATCH`/api/subscriptions/products/{id}/notes/{noteId}`

DELETE`/api/subscriptions/products/{id}`

DELETE`/api/subscriptions/products/{id}/assignees/{userId}`

DELETE`/api/subscriptions/products/{id}/comments/{commentId}`

DELETE`/api/subscriptions/products/{id}/notes/{noteId}`

GET`/api/subscriptions/plans`

GET`/api/subscriptions/plans/{id}`

GET`/api/subscriptions/plans/{id}/comments`

GET`/api/subscriptions/plans/{id}/dependencies`

GET`/api/subscriptions/plans/{id}/email-check`

GET`/api/subscriptions/plans/{id}/related`

GET`/api/subscriptions/plans/{id}/related/{module}`

GET`/api/subscriptions/plans/{id}/similar`

GET`/api/subscriptions/plans/{id}/timeline`

GET`/api/subscriptions/plans/export.csv`

GET`/api/subscriptions/plans/kanban`

GET`/api/subscriptions/plans/pivot`

POST`/api/subscriptions/plans`

POST`/api/subscriptions/plans/{id}/assignees`

POST`/api/subscriptions/plans/{id}/comments`

POST`/api/subscriptions/plans/{id}/email`

POST`/api/subscriptions/plans/{id}/notes`

POST`/api/subscriptions/plans/bulk`

POST`/api/subscriptions/plans/bulk/assign`

POST`/api/subscriptions/plans/bulk/delete`

POST`/api/subscriptions/plans/import`

PATCH`/api/subscriptions/plans/{id}`

PATCH`/api/subscriptions/plans/{id}/notes/{noteId}`

DELETE`/api/subscriptions/plans/{id}`

DELETE`/api/subscriptions/plans/{id}/assignees/{userId}`

DELETE`/api/subscriptions/plans/{id}/comments/{commentId}`

DELETE`/api/subscriptions/plans/{id}/notes/{noteId}`

GET`/api/subscriptions/addons`

GET`/api/subscriptions/addons/{id}`

GET`/api/subscriptions/addons/{id}/comments`

GET`/api/subscriptions/addons/{id}/dependencies`

GET`/api/subscriptions/addons/{id}/email-check`

GET`/api/subscriptions/addons/{id}/related`

GET`/api/subscriptions/addons/{id}/related/{module}`

GET`/api/subscriptions/addons/{id}/similar`

GET`/api/subscriptions/addons/{id}/timeline`

GET`/api/subscriptions/addons/export.csv`

GET`/api/subscriptions/addons/kanban`

GET`/api/subscriptions/addons/pivot`

POST`/api/subscriptions/addons`

POST`/api/subscriptions/addons/{id}/assignees`

POST`/api/subscriptions/addons/{id}/comments`

POST`/api/subscriptions/addons/{id}/email`

POST`/api/subscriptions/addons/{id}/notes`

POST`/api/subscriptions/addons/bulk`

POST`/api/subscriptions/addons/bulk/assign`

POST`/api/subscriptions/addons/bulk/delete`

POST`/api/subscriptions/addons/import`

PATCH`/api/subscriptions/addons/{id}`

PATCH`/api/subscriptions/addons/{id}/notes/{noteId}`

DELETE`/api/subscriptions/addons/{id}`

DELETE`/api/subscriptions/addons/{id}/assignees/{userId}`

DELETE`/api/subscriptions/addons/{id}/comments/{commentId}`