Permission Scopes

An overview of all permission scopes available for the API.

Access Tokens

tokens.read

Read access token details

tokens.write

Create, update, or delete access tokens

Customers

customers.read

Read customer details

customers.write

Create, update, or delete customers

Invoices

invoices.read

Read invoice details

invoices.write

Create, update, or delete invoices

Logs

logs.read

Read API request and response logs

Metrics

metrics.read

Read analytics and reporting metrics

Pages

pages.read

Read page details

pages.write

Create, update, or delete pages

Payments

payments.read

Read payment details

payments.initiate

Initiate new payment requests

payments.refund

Issue refunds on completed payments

Plans

plans.read

Read plan details

plans.write

Create, update, or delete plans

Providers

providers.read

Read payment provider details

providers.write

Create, update, or delete payment providers

Subscriptions

subscriptions.read

Read subscription details

subscriptions.write

Create, update, or delete subscriptions

Transfers

transfers.initiate

Initiate new transfers

transfers.approve

Approve pending transfers

transfers.cancel

Cancel pending transfers

Vouchers

vouchers.read

Read voucher details

vouchers.apply

Apply vouchers to invoices

vouchers.write

Create, update, or delete vouchers

Wallets

wallets.read

Read wallet details

wallets.write

Create, update, or delete wallets

Wallet Balances

wallets.balances.read

Read wallet balance details

wallets.balances.write

Create, update, or delete wallet balances

Wallet Accounts

wallets.accounts.read

Read linked bank account details

wallets.accounts.write

Create, update, or delete linked bank accounts

Wallet Contacts

wallets.contacts.read

Read wallet contact details

wallets.contacts.write

Create, update, or delete wallet contacts

Wallet PIN

wallets.pin.write

Update or rotate the wallet PIN

Webhooks

webhooks.read

Read webhook details

webhooks.write

Create, update, or delete webhooks

Webhook Secret

webhooks.secret.read

Read the webhook signing secret

webhooks.secret.write

Rotate the webhook signing secret

Last updated on September 1, 2026.