Endpoints

PreviousAuthentication

Last updated 29 days ago

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();

{
  "meta": {
    "page": {}
  },
  "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": "2024-11-16T07:43:27.033Z",
        "updatedAt": "2024-11-16T07:43:27.033Z",
        "isGroup": false,
        "belongsToGroup": false,
        "isArchived": false
      },
      "relationships": {
        "subscriptions": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

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();

{
  "meta": {
    "page": {}
  },
  "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": "2024-11-16T07:43:27.033Z",
        "createdAt": "2024-11-16T07:43:27.033Z",
        "updatedAt": "2024-11-16T07:43:27.033Z"
      },
      "relationships": {
        "subscriptions": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

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();

{
  "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": "2024-11-16T07:43:27.033Z",
      "createdAt": "2024-11-16T07:43:27.033Z",
      "updatedAt": "2024-11-16T07:43:27.033Z"
    },
    "relationships": {
      "subscriptions": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

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();

{
  "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": "2024-11-16T07:43:27.033Z",
      "updatedAt": "2024-11-16T07:43:27.033Z",
      "isGroup": false,
      "belongsToGroup": false,
      "isArchived": false
    },
    "relationships": {
      "subscriptions": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

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();

{
  "meta": {
    "page": {}
  },
  "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": "2024-11-16T07:43:27.033Z",
        "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": "2024-11-16T07:43:27.033Z",
        "updatedAt": "2024-11-16T07:43:27.033Z"
      },
      "relationships": {
        "accounts": "text",
        "subscription-items": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

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();

{
  "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": "2024-11-16T07:43:27.033Z",
      "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": "2024-11-16T07:43:27.033Z",
      "updatedAt": "2024-11-16T07:43:27.033Z"
    },
    "relationships": {
      "accounts": "text",
      "subscription-items": "text"
    },
    "links": {
      "self": "text"
    }
  }
}