Get the company

GET

https://api.schematichq.com/company

GET

/company

const url = 'https://api.schematichq.com/company';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "add_ons": [
      {
        "id": "string",
        "included_credit_ids": [
          "string"
        ],
        "name": "string",
        "description": "string",
        "period": "string",
        "price": 1
      }
    ],
    "id": "string",
    "name": "string",
    "custom_plan_billing": {
      "activation_strategy": "on_payment",
      "due_at": "2024-01-15T09:30:00Z",
      "plan_id": "string",
      "invoice_url": "string",
      "plan_name": "string"
    },
    "plan": {
      "id": "string",
      "included_credit_ids": [
        "string"
      ],
      "name": "string",
      "description": "string",
      "period": "string",
      "price": 1
    },
    "scheduled_downgrade": {
      "from_plan_id": "string",
      "from_plan_name": "string",
      "to_plan_id": "string",
      "to_plan_name": "string"
    },
    "subscription": {
      "cancel_at_period_end": true,
      "currency": "aed",
      "status": "string",
      "cancel_at": "2024-01-15T09:30:00Z",
      "next_bill_at": "2024-01-15T09:30:00Z",
      "period": "string",
      "period_end": "2024-01-15T09:30:00Z",
      "trial_end": "2024-01-15T09:30:00Z"
    }
  },
  "params": {}
}

The token’s company: its plan and add-ons, the subscription’s period and currency, and the payment method on file. Needs the company-context-api flag on the account; without it every /company read answers 404.

Authentication

X-Schematic-Api-Keystring

A temporary access token in the X-Schematic-Api-Key header. Your server mints it with POST /temporary-access-tokens on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error