Subscribe to an addon

POST /api/v1/subscribe

Personal access token & O auth2

application/json

Body Required

addon_id string Required

Unique identifier of the addon to subscribe to
config array[string]

Configuration parameters dependant on type of addon
enabled boolean Required

If the addon should start enabled

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- enabled string
  
  Determines if the addon is enabled
- addon object
  
  Details about the addon subscribed to
  
  Hide addon attributes Show addon attributes object
  
  id string
  
  name string
  
  description string
  
  setup_instructions string
  
  category string
  
  params object
  
  Hide params attributes Show params attributes object
  
  access_code object
  
  Hide access_code attributes Show access_code attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  pin object
  
  Hide pin attributes Show pin attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  second_access_code object
  
  Hide second_access_code attributes Show second_access_code attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  second_pin object
  
  Hide second_pin attributes Show second_pin attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  third_access_code object
  
  Hide third_access_code attributes Show third_access_code attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  third_pin object
  
  Hide third_pin attributes Show third_pin attributes object
  
  type string
  
  description string
  
  example string
  
  options array
  
  required boolean
  
  inputs array
  
  list_type string
  
  attributes array
  
  banner_url string
  
  icon_url string
  
  price object
  
  Hide price attributes Show price attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  can_be_subscribed_to boolean
  
  is_visible boolean
  
  free_trial_days integer
- trial_ends_at string
  
  If the addon is a paid addon, this is the date the free trial will end for the addon subscription.
- trial_ends_in_days integer
  
  If the addon is a paid addon, this is the number of days left in the free trial for the addon subscription.
- payment_confirmed_at string
  
  If the addon is a paid addon, this is the date the payment was confirmed for the addon subscription.

POST /api/v1/subscribe

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/subscribe' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"addon_id":"transact_valuation_feed","config":[{"api_key":"apikey123"}],"enabled":true}'

Request examples

{
  "addon_id": "transact_valuation_feed",
  "config": [
    {
      "api_key": "apikey123"
    }
  ],
  "enabled": true
}

Response examples (200)

{
  "uuid": "8e63ab57-f126-4b37-a427-c44482e85729",
  "addon": {
    "id": "transact_valuation_feed",
    "name": "Transact Valuation Feed",
    "price": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "params": {
      "pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "TRDS Password (Not Your Transact Password)"
      },
      "third_pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "Third TRDS Password (Not Your Transact Password)"
      },
      "second_pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "Second TRDS Password (Not Your Transact Password)"
      },
      "access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "Transact Number"
      },
      "third_access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "Third Transact Number"
      },
      "second_access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "attributes": [],
        "description": "Second Transact Number"
      }
    },
    "category": "valuation_feed_integration",
    "icon_url": "https://plannrcrm.com/icon.png",
    "banner_url": "https://plannrcrm.com/banner.png",
    "is_visible": true,
    "description": "Provides an automatic holding and valuation feed via a transact integration",
    "free_trial_days": 30,
    "setup_instructions": "Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/",
    "can_be_subscribed_to": true
  },
  "enabled": "true",
  "created_at": "2025-06-26T11:37:10+01:00",
  "updated_at": "2025-06-26T11:37:10+01:00",
  "trial_ends_at": "2025-07-10",
  "trial_ends_in_days": 14,
  "payment_confirmed_at": "2025-07-14"
}