Endpoints

PreviousAuthentication

Last updated 1 month ago

Endpoints

Get all accounts

GEThttps://api.plock.io/api/c1/accounts

Authorization

Query parameters

Header parameters

Response

Body

metaJsonApiMeta (object)

jsonapiJsonApiVersion (object)

linksJsonApiLinks (object)

dataarray of Accounts (object)

Request

const response = await fetch('https://api.plock.io/api/c1/accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "meta": {
    "page": {
      "currentPage": 0,
      "from": 0,
      "lastPage": 0,
      "perPage": 0,
      "to": 0,
      "total": 0
    }
  },
  "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-01-18T04:55:04.004Z",
        "updatedAt": "2025-01-18T04:55:04.004Z",
        "isGroup": false,
        "belongsToGroup": false,
        "isArchived": false
      },
      "relationships": {
        "subscriptions": "text",
        "invoices": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific account

GEThttps://api.plock.io/api/c1/accounts/{accountId}

Authorization

Path parameters

accountId*integer

Plock account ID

Query parameters

Header parameters

Response

Body

jsonapiJsonApiVersion (object)

linksJsonApiLinksSingle (object)

dataAccounts (object)

Request

const response = await fetch('https://api.plock.io/api/c1/accounts/{accountId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "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-01-18T04:55:04.004Z",
      "updatedAt": "2025-01-18T04:55:04.004Z",
      "isGroup": false,
      "belongsToGroup": false,
      "isArchived": false
    },
    "relationships": {
      "subscriptions": "text",
      "invoices": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all subscriptions

GEThttps://api.plock.io/api/c1/subscriptions

Authorization

Query parameters

Header parameters

Response

Body

metaJsonApiMeta (object)

jsonapiJsonApiVersion (object)

linksJsonApiLinks (object)

dataarray of Subscriptions (object)

Request

const response = await fetch('https://api.plock.io/api/c1/subscriptions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "meta": {
    "page": {
      "currentPage": 0,
      "from": 0,
      "lastPage": 0,
      "perPage": 0,
      "to": 0,
      "total": 0
    }
  },
  "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": false,
        "billingCycleAnchor": "2025-01-18T04:55:04.004Z",
        "renewalDate": "2025-06-30",
        "rebateEndDate": "2024-07-01",
        "rebateAmount": 2000,
        "rebateType": "percent",
        "currency": "SEK",
        "minimumCommitment": 2000,
        "currentBillingPeriod": "2024-03-01 - 2024-03-31",
        "autoSendToAccounting": false,
        "endDate": "2024-07-01",
        "createdAt": "2025-01-18T04:55:04.004Z",
        "updatedAt": "2025-01-18T04:55:04.004Z"
      },
      "relationships": {
        "accounts": "text",
        "invoices": "text",
        "subscription-items": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific subscription

GEThttps://api.plock.io/api/c1/subscriptions/{subscriptionId}

Authorization

Path parameters

subscriptionId*integer

Plock subscription ID

Query parameters

Header parameters

Response

Body

jsonapiJsonApiVersion (object)

linksJsonApiLinksSingle (object)

dataSubscriptions (object)

Request

const response = await fetch('https://api.plock.io/api/c1/subscriptions/{subscriptionId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "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": false,
      "billingCycleAnchor": "2025-01-18T04:55:04.004Z",
      "renewalDate": "2025-06-30",
      "rebateEndDate": "2024-07-01",
      "rebateAmount": 2000,
      "rebateType": "percent",
      "currency": "SEK",
      "minimumCommitment": 2000,
      "currentBillingPeriod": "2024-03-01 - 2024-03-31",
      "autoSendToAccounting": false,
      "endDate": "2024-07-01",
      "createdAt": "2025-01-18T04:55:04.004Z",
      "updatedAt": "2025-01-18T04:55:04.004Z"
    },
    "relationships": {
      "accounts": "text",
      "invoices": "text",
      "subscription-items": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all subscription items

GEThttps://api.plock.io/api/c1/subscription-items

Authorization

Query parameters

Header parameters

Response

Body

metaJsonApiMeta (object)

jsonapiJsonApiVersion (object)

linksJsonApiLinks (object)

dataarray of SubscriptionItems (object)

Request

const response = await fetch('https://api.plock.io/api/c1/subscription-items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "meta": {
    "page": {
      "currentPage": 0,
      "from": 0,
      "lastPage": 0,
      "perPage": 0,
      "to": 0,
      "total": 0
    }
  },
  "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-01-18T04:55:04.004Z",
        "createdAt": "2025-01-18T04:55:04.004Z",
        "updatedAt": "2025-01-18T04:55:04.004Z"
      },
      "relationships": {
        "subscriptions": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific subscription item

GEThttps://api.plock.io/api/c1/subscription-items/{subscriptionItemId}

Authorization

Path parameters

subscriptionItemId*integer

Plock subscription item ID

Query parameters

Header parameters

Response

Body

jsonapiJsonApiVersion (object)

linksJsonApiLinksSingle (object)

dataSubscriptionItems (object)

Request

const response = await fetch('https://api.plock.io/api/c1/subscription-items/{subscriptionItemId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "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-01-18T04:55:04.004Z",
      "createdAt": "2025-01-18T04:55:04.004Z",
      "updatedAt": "2025-01-18T04:55:04.004Z"
    },
    "relationships": {
      "subscriptions": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get all invoices

GEThttps://api.plock.io/api/c1/invoices

Authorization

Query parameters

Header parameters

Response

Body

metaJsonApiMeta (object)

jsonapiJsonApiVersion (object)

linksJsonApiLinks (object)

dataarray of Invoices (object)

Request

const response = await fetch('https://api.plock.io/api/c1/invoices', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "meta": {
    "page": {
      "currentPage": 0,
      "from": 0,
      "lastPage": 0,
      "perPage": 0,
      "to": 0,
      "total": 0
    }
  },
  "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-01-18",
        "periodEnd": "2025-01-18",
        "createdAt": "2025-01-18T04:55:04.004Z",
        "updatedAt": "2025-01-18T04:55:04.004Z",
        "dueAt": "2025-01-18T04:55:04.004Z",
        "paymentStatus": "Paid",
        "parentInvoiceId": 1001,
        "isParent": false
      },
      "relationships": {
        "subscriptions": "text",
        "accounts": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific invoice

GEThttps://api.plock.io/api/c1/invoices/{invoiceId}

Authorization

Path parameters

invoiceId*integer

Plock invoice ID

Query parameters

Header parameters

Response

Body

jsonapiJsonApiVersion (object)

linksJsonApiLinksSingle (object)

dataInvoices (object)

Request

const response = await fetch('https://api.plock.io/api/c1/invoices/{invoiceId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Accept": "application/vnd.api+json"
    },
});
const data = await response.json();

Response

{
  "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-01-18",
      "periodEnd": "2025-01-18",
      "createdAt": "2025-01-18T04:55:04.004Z",
      "updatedAt": "2025-01-18T04:55:04.004Z",
      "dueAt": "2025-01-18T04:55:04.004Z",
      "paymentStatus": "Paid",
      "parentInvoiceId": 1001,
      "isParent": false
    },
    "relationships": {
      "subscriptions": "text",
      "accounts": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

PreviousAuthentication

Last updated 1 month ago