getPlatformInfo

API reference for the getPlatformInfo method.

This version of the API is in beta. Beta APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Returns information about the platform on which the app is running.

Returns

Information about the platform on which the app is running.

canAcceptPaymentsboolean

If true, the app is allowed to directly link to payment and upgrade flows.

This property is always true when the app is running in a web browser, but may otherwise be false in order to comply with the policies of the platforms on which Canva is available. For example, some platforms only allow payment-related actions that use their own payment mechanisms and apps are therefore not allowed to render payment-related call-to-actions while running on those platforms.

Example

const info = getPlatformInfo();

if (info.canAcceptPayments) {
  // Display payment links and upgrade flows
} else {
  // Hide payment links and upgrade flows
  // Optionally, show an appropriate message
}