KDPika Licensing Sign inStart free
API v1
Show all languages
Browse documentation

Choose a page in the navigation drawer.

KDPika Licensing · API v1 Beginner

Core concepts

Learn the relationships between your workspace, products, plans, customers, licenses, installations, tokens and events.

On this page
Updated 2026-10-17 UTCDownload Markdown

A product plan describes access rules; a license grants those rules to one customer in one environment.

What you will learn

  • How the main records relate.
  • Which identifiers are public and which are secrets.
  • Which limits and environments belong to which layer.

Prerequisites

Relationships

An organization owns products and customers. A product has product plans and features. A customer license references one plan and environment; devices and activation tokens belong to that license.
An organization owns products and customers. A product has product plans and features. A customer license references one plan and environment; devices and activation tokens belong to that license.

Record reference

ConceptPurposeImportant distinction
OrganizationTenant owning the workspace records and platform subscriptionNot a software buyer account
ProductYour application definition, public App ID and validation policyShared configuration across Sandbox and Live
Public App IDNonsecret product identifier supplied as X-App-ID during activationNot a secret developer API key
Product planTemplate for duration, features, device and cumulative activation limitsIts price is metadata, not a buyer checkout
Feature or entitlementA named boolean or typed JSON value returned in signed dataYour app must enforce it after validation
CustomerYour software buyer or license recipientDistinct from you paying KDPika
LicenseCustomer/product/plan/environment access record with status and optional expiryNot the printable license key alone
License keySecret used to activate a licenseCopy it at issuance; listings show a mask
Installation IDStable random identity generated and persisted by your appNot a MAC address or serial number
DeviceServer record for a hashed installation identityNot guaranteed unique physical hardware
ActivationRegistering an installation and obtaining a tokenActive seats and cumulative activations differ
Activation tokenSecret used to validate or deactivate the activated installationBound to its license/device; do not share
EnvironmentSandbox or Live boundary for licenses, customers, credentials and endpointsNot the payment provider's Test/Live mode
Developer API keyScoped server-side credential for managementNever distribute in application binaries
WebhookSigned outbound notification to your backendNot an authority that decides license validity

Product and platform plans

Your platform subscription defines workspace capacity and billing. Your own product plans define what your customers may use. A monthly product plan does not automatically charge a buyer or renew a license after a sale.

Products, plans and features are shared configuration. Licenses and customers belong to an environment; devices inherit that environment through the license. Usage totals can span both licensing environments.

Features and changes

Require a valid result before reading a feature. Current helpers can expose a payload value even when the result is invalid; the caller must apply the validity guard.

Device and cumulative activation limits are copied when issuing a license. Changing the product plan does not retroactively replace those copies. Feature resolution uses plan features with license-level overrides; an offline app cannot see a fresh change before reconnecting.

Expected result

You can trace a customer license to its product, plan, environment, devices and token without confusing it with a platform billing subscription.

Common mistakes

  • Counting active licenses as activation requests: a license can have multiple devices and many validations.
  • Resetting devices to clear cumulative activations: reset releases seats and revokes tokens, not that counter.
  • Treating a feature as a usage meter: implement metering and business rules in your own backend.

Security notes

Customer emails and metadata can be personal data. Hashing an installation ID does not automatically make the complete record anonymous. Avoid unnecessary personal data in labels and metadata.

Troubleshooting

SymptomCauseFix
Existing limit did not change after editing a planThe license stores its issued limitsReview the individual license and supported management operations
More than one device uses one licenseIts per-license device policy allows itReview max_devices and your transfer policy
A plan's price appears in a response but no charge occursLicensing metadata is not payment processingUse your own confirmed payment/fulfilment flow

Next steps

Read authentication and the license lifecycle.

Was this page helpful?

Choose an answer

Do not include personal data, license keys or credentials. Retained for up to 30 days. This is not a support inbox.

Search documentation

Arrow keys to move, Enter to open, Escape to close. Search stays in your browser.

Cookie settings