Get plan usage
get_plan_usageGet the account's plan and how many of its active transfers are in use. Free accounts have no active-transfer cap; lookup and request rate limits still apply. On a paid plan, a finished transfer keeps its place until it archives itself a week after its last check, and can be archived sooner to free the place. Archived transfers stay in the account and never count. On a custom package, also how many transfers were added in the current billing period against the package's volume, and when it resets. Reading changes nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | ||
| package | Yes | Null unless the account has a custom package. Adds stop with monthly_limit_reached once added_this_period reaches included_transfers plus additional_transfers. | |
| active_transfers | Yes | Null unless the account has an active paid plan. Null means this account is not measured against an active-transfer allowance; it does not mean zero transfers remain. Free accounts have no active-transfer cap; lookup and request rate limits still apply. get_account gives the subscription status. |