Chapter 410: getUsage()

Core Idea

Allows you to get the current usage of your Remotion license. This requires your secret key that you can obtain from the remotion.

Key Concepts

• API
• licenseKey<AvailableFrom v="4.0.409"/>
• since
• apiKey
• Return value
• webRenders<AvailableFrom v="4.0.428"/>
• webcodecConversions
• cloudRenders

Code Examples

const usage = await getUsage({
  licenseKey: 'rm_sec_xxxxx',
  since: Date.now() - 1000 * 60 * 60 * 24 * 30, // 30 days ago
});

console.log(usage);
/*
{
  "webRenders": {
    "billable": 10,
    "development": 5,
    "failed": 2
  },
  "cloudRenders": {
    "billable": 10,
    "development": 5,
    "failed": 2
  },
}
*/

• What it demonstrates: Usage pattern for getUsage() from the official docs.

Key Takeaways

1. Understand api when working with getUsage().
2. Understand licensekey<availablefrom v="4.0.409"/> when working with getUsage().
3. Understand since when working with getUsage().
4. Understand apikey when working with getUsage().
5. Understand return value when working with getUsage().

Connects To

• Accessibility: related page in the Legal, Meta & Support section.
• dev: related page in the Legal, Meta & Support section.
• pro: related page in the Legal, Meta & Support section.