getPlatformInfo

API reference for the getPlatformInfo method.

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

import { getPlatformInfo } from "@canva/platform";
const info = getPlatformInfo();
console.log(info); // => { ... }
ts
#resultobject
Required

Information about the platform on which the app is running.

#result.canAcceptPaymentsboolean
Required

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

This is sometimes 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.

To learn more, see Accepting payments.