Get subscription activities

curl --request GET \
  --url https://external.pleo.io/v1/subscriptions/{id}/activities \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://external.pleo.io/v1/subscriptions/{id}/activities', 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://external.pleo.io/v1/subscriptions/{id}/activities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://external.pleo.io/v1/subscriptions/{id}/activities"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v1/subscriptions/{id}/activities")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "actorUrn": "urn:pleo:organisation:12345678-1234-1234-1234-123456789012",
      "createdAt": "2022-01-01T00:00:00Z",
      "description": "Subscription deleted",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "CREATE",
      "subscriptionId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

"The subscription record could not be found."

GET

subscriptions

{id}

activities

Get subscription activities

curl --request GET \
  --url https://external.pleo.io/v1/subscriptions/{id}/activities \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://external.pleo.io/v1/subscriptions/{id}/activities', 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://external.pleo.io/v1/subscriptions/{id}/activities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://external.pleo.io/v1/subscriptions/{id}/activities"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v1/subscriptions/{id}/activities")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "actorUrn": "urn:pleo:organisation:12345678-1234-1234-1234-123456789012",
      "createdAt": "2022-01-01T00:00:00Z",
      "description": "Subscription deleted",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "CREATE",
      "subscriptionId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

"The subscription record could not be found."

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

The unique identifier of the subscription

Query Parameters

operation_types

enum<string>[]

Filters subscriptions by operationTypes. If the value is null, all subscription activities for the specified subscriptionId are returned.

Available options:

CREATE,

UPDATE,

DELETE

before

string

Lower bound of the page of data to return (cannot be used together with [after] or [offset])

after

string

Upper bound of the page of data to return (cannot be used together with [before] or [offset])

offset

integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after])

limit

integer<int32>

The maximum amount of items to return

sorting_keys

string[]

The keys to sort the results by

sorting_order

enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key

Available options:

ASC,

ASC_NULLS_FIRST,

ASC_NULLS_LAST,

DESC,

DESC_NULLS_FIRST,

DESC_NULLS_LAST

Response

The subscription activities are returned.

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

ABOUT THE PLEO API

EXPORT API

TAGS API

TAX CODE API

APP MARKETPLACE API

EMPLOYEES API

BOOKKEEPING CORE API

WEBHOOK SUBSCRIPTIONS API

COMPANIES API

VENDORS API

PLEO.IO API (DEPRECATED)

Get subscription activities

Authorizations

Path Parameters

Query Parameters

Response