Endpoints | Plock.io

Plock.io

Get all accounts

get

Authorizations

Query parameters

pageobjectoptional

Pagination number and size

filterobjectoptional

Filter to use

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "accounts",
      "id": "2002",
      "attributes": {
        "primaryKey": "a443322",
        "name": "Some Company AB",
        "orgNumber": "554433-3344",
        "crmId": "hs321",
        "erpId": "fn432",
        "country": "Sweden",
        "parentAccountId": 1,
        "createdAt": "2025-04-03T02:51:23.346Z",
        "updatedAt": "2025-04-03T02:51:23.346Z",
        "isGroup": true,
        "belongsToGroup": true,
        "isArchived": true,
        "stats": {
          "mrr_committed_fees": [
            100.5,
            200.3,
            300.2
          ],
          "mrr_usage_fees": [
            0,
            0,
            0
          ],
          "mrr_one_time_fees": [
            0,
            0,
            200
          ],
          "billings_committed_fees": [
            0,
            0,
            601
          ],
          "billings_usage_fees": [
            0,
            0,
            0
          ],
          "billings_one_time_fees": [
            0,
            0,
            200
          ]
        }
      },
      "relationships": {
        "subscriptions": "text",
        "invoices": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific account

get

Authorizations

Path parameters

accountIdintegerrequired

Plock account ID

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

404

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": {
    "type": "accounts",
    "id": "2002",
    "attributes": {
      "primaryKey": "a443322",
      "name": "Some Company AB",
      "orgNumber": "554433-3344",
      "crmId": "hs321",
      "erpId": "fn432",
      "country": "Sweden",
      "parentAccountId": 1,
      "createdAt": "2025-04-03T02:51:23.346Z",
      "updatedAt": "2025-04-03T02:51:23.346Z",
      "isGroup": true,
      "belongsToGroup": true,
      "isArchived": true,
      "stats": {
        "mrr_committed_fees": [
          100.5,
          200.3,
          300.2
        ],
        "mrr_usage_fees": [
          0,
          0,
          0
        ],
        "mrr_one_time_fees": [
          0,
          0,
          200
        ],
        "billings_committed_fees": [
          0,
          0,
          601
        ],
        "billings_usage_fees": [
          0,
          0,
          0
        ],
        "billings_one_time_fees": [
          0,
          0,
          200
        ]
      }
    },
    "relationships": {
      "subscriptions": "text",
      "invoices": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all subscriptions

get

Authorizations

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/subscriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "subscriptions",
      "id": "2002",
      "attributes": {
        "accountId": "2002",
        "name": "My annual subscription",
        "billingInterval": "month",
        "billingIntervalName": "Monthly in arrears",
        "billingPractice": "in_arrears",
        "state": "Ended",
        "billingIntervalCount": 12,
        "isActive": true,
        "billingCycleAnchor": "2025-04-03T02:51:23.346Z",
        "renewalDate": "2025-06-30",
        "rebateEndDate": "2024-07-01",
        "rebateAmount": 2000,
        "rebateType": "percent",
        "currency": "SEK",
        "minimumCommitment": 2000,
        "currentBillingPeriod": "2024-03-01 - 2024-03-31",
        "autoSendToAccounting": true,
        "endDate": "2024-07-01",
        "createdAt": "2025-04-03T02:51:23.346Z",
        "updatedAt": "2025-04-03T02:51:23.346Z"
      },
      "relationships": {
        "accounts": "text",
        "invoices": "text",
        "subscription-items": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific subscription

get

Authorizations

Path parameters

subscriptionIdintegerrequired

Plock subscription ID

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/subscriptions/{subscriptionId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

404

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": {
    "type": "subscriptions",
    "id": "2002",
    "attributes": {
      "accountId": "2002",
      "name": "My annual subscription",
      "billingInterval": "month",
      "billingIntervalName": "Monthly in arrears",
      "billingPractice": "in_arrears",
      "state": "Ended",
      "billingIntervalCount": 12,
      "isActive": true,
      "billingCycleAnchor": "2025-04-03T02:51:23.346Z",
      "renewalDate": "2025-06-30",
      "rebateEndDate": "2024-07-01",
      "rebateAmount": 2000,
      "rebateType": "percent",
      "currency": "SEK",
      "minimumCommitment": 2000,
      "currentBillingPeriod": "2024-03-01 - 2024-03-31",
      "autoSendToAccounting": true,
      "endDate": "2024-07-01",
      "createdAt": "2025-04-03T02:51:23.346Z",
      "updatedAt": "2025-04-03T02:51:23.346Z"
    },
    "relationships": {
      "accounts": "text",
      "invoices": "text",
      "subscription-items": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all subscription items

get

Authorizations

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/subscription-items' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "subscriptions",
      "id": "2002",
      "attributes": {
        "planName": "Annual price",
        "productName": "Send SMS",
        "quantity": 100,
        "rebateAmount": 10,
        "rebateType": "percent",
        "rebateEndDate": "2025-04-03T02:51:23.346Z",
        "createdAt": "2025-04-03T02:51:23.346Z",
        "updatedAt": "2025-04-03T02:51:23.346Z"
      },
      "relationships": {
        "subscriptions": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific subscription item

get

Authorizations

Path parameters

subscriptionItemIdintegerrequired

Plock subscription item ID

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/subscription-items/{subscriptionItemId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

404

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": {
    "type": "subscriptions",
    "id": "2002",
    "attributes": {
      "planName": "Annual price",
      "productName": "Send SMS",
      "quantity": 100,
      "rebateAmount": 10,
      "rebateType": "percent",
      "rebateEndDate": "2025-04-03T02:51:23.346Z",
      "createdAt": "2025-04-03T02:51:23.346Z",
      "updatedAt": "2025-04-03T02:51:23.346Z"
    },
    "relationships": {
      "subscriptions": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all invoices

get

Authorizations

Query parameters

pageobjectoptional

Pagination number and size

filterobjectoptional

Filter to use

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/invoices' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "invoices",
      "id": "2002",
      "attributes": {
        "amount": "1000.00",
        "accountId": "5001",
        "erpId": "fn123",
        "subscriptionId": "4342",
        "currency": "EUR",
        "invoiceType": "In arrears",
        "periodStart": "2025-04-03",
        "periodEnd": "2025-04-03",
        "createdAt": "2025-04-03T02:51:23.346Z",
        "updatedAt": "2025-04-03T02:51:23.346Z",
        "dueAt": "2025-04-03T02:51:23.346Z",
        "paymentStatus": "Paid",
        "parentInvoiceId": 1001,
        "isParent": false
      },
      "relationships": {
        "subscriptions": "text",
        "accounts": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific invoice

get

Authorizations

Path parameters

invoiceIdintegerrequired

Plock invoice ID

Query parameters

pageobjectoptional

Pagination number and size

Header parameters

Acceptstring · enumrequired

The client must specify an Accept header.

Available options:

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.plock.io/api/c1/invoices/{invoiceId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: application/vnd.api+json'

200

401

404

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": {
    "type": "invoices",
    "id": "2002",
    "attributes": {
      "amount": "1000.00",
      "accountId": "5001",
      "erpId": "fn123",
      "subscriptionId": "4342",
      "currency": "EUR",
      "invoiceType": "In arrears",
      "periodStart": "2025-04-03",
      "periodEnd": "2025-04-03",
      "createdAt": "2025-04-03T02:51:23.346Z",
      "updatedAt": "2025-04-03T02:51:23.346Z",
      "dueAt": "2025-04-03T02:51:23.346Z",
      "paymentStatus": "Paid",
      "parentInvoiceId": 1001,
      "isParent": false
    },
    "relationships": {
      "subscriptions": "text",
      "accounts": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all accounts

Show child attributes

Show child attributes

Get specific account

Show child attributes

Get all subscriptions

Show child attributes

Get specific subscription

Show child attributes

Get all subscription items

Show child attributes

Get specific subscription item

Show child attributes

Get all invoices

Show child attributes

Show child attributes

Get specific invoice

Show child attributes