> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# getPlatformInfo

API reference for the getPlatformInfo method.

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

## Usage

### Get platform information

```typescript
import { getPlatformInfo } from '@canva/platform';

const platformInfo = await getPlatformInfo();
```

### Check if app is running on platform that allows payments

```typescript
import { getPlatformInfo } from '@canva/platform';

const platformInfo = await getPlatformInfo();

if (platformInfo.canAcceptPayments) {
  // Show payment-related UI elements
} else {
  // Hide payment-related UI elements
}
```

## Returns

Information about the platform on which the app is running.

<Prop.List>
  <Prop name="canAcceptPayments" required type="boolean" sourceLineNumbers={[600]}>
    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.

    <Prop.Extras>
      **Example**

      ```ts
      const info = getPlatformInfo();

      if (info.canAcceptPayments) {
        // Display payment links and upgrade flows
      } else {
        // Hide payment links and upgrade flows
        // Optionally, show an appropriate message
      }
      ```
    </Prop.Extras>
  </Prop>
</Prop.List>