PEpennylane
Company

Company features

Changed on

Effective availability of the features that are gated for this company, so that they can be checked before calling the endpoints they restrict. A feature is true only when every gate is open, including the billing plan and the progressive rollout, so it can be false on a plan that includes it. Keys are added here as new gated features are introduced.

get/api/external/v2/company/features

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/company/features
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

Returns the features of the company

installmentsboolean required

Whether the company can pay a customer invoice in several installments. When false, sending installments on the creation of a customer invoice either responds with 403 or is ignored and creates a single installment, so check this field rather than relying on the response.

custom_fieldsboolean required

Whether the company can set custom fields on customer invoices, quotes, and products. True only when the billing plan includes custom field definitions and the rollout is open. When the rollout is closed, sending custom_fields is refused with 422.

Example response

{
  "installments": true,
  "custom_fields": true
}

Changes