Raims CLIAPI commands
raims refunds
Inspect refunds and receipts
Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.
raims refunds
Inspect refunds and receipts
Shell
raims refunds [flags]--help,-hbooldefault: false- help for refunds
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
Subcommands: raims refunds get, raims refunds list, raims refunds receipt.
raims refunds get
Get a refund
Shell
raims refunds get ID [flags]--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for get
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
Get a refund.
GET /v1/refunds/{id}
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.Command example
Shell
raims --profile PROFILE --output json refunds get ID --dry-runraims refunds list
List refunds
Shell
raims refunds list [flags]--afterstringdefault: empty- Read after this opaque cursor (cannot be combined with --before)
--allbooldefault: false- Read all pages as separate results (JSON Lines with --output json)
--beforestringdefault: empty- Read before this opaque cursor (cannot be combined with --after)
--created-gteint64default: 0- Created at or after this Unix timestamp (seconds)
--created-lteint64default: 0- Created at or before this Unix timestamp (seconds)
--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for list
--max-pagesintdefault: 100- Maximum pages to read with --all (1-10000)
--page-sizeint64default: 10- Results per page (the API normalizes the requested size)
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
List refunds.
GET /v1/refunds
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.Command example
Shell
raims --profile PROFILE --output json refunds list --dry-runraims refunds receipt
Get the refund receipt download information
Shell
raims refunds receipt ID [flags]--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for receipt
--savestringdefault: empty- Save the PDF to PATH (up to 32 MiB); the parent directory must exist and the file must not exist
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
--colorstringdefault: auto- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debugbooldefault: false- Write diagnostic JSON events to stderr without credentials or command arguments
--environmentstringdefault: empty- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--mapstringdefault: empty- List the command tree without executing a command: tree, compact, paths or json
--no-inputbooldefault: false- Disable interactive prompts (also enforced in CI and without a terminal)
--output,-ostringdefault: text- Output format: text or json
--profilestringdefault: empty- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
Get the refund receipt download information.
GET /v1/refunds/{id}/receipt
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.Command example
Shell
raims --profile PROFILE --output json refunds receipt ID --dry-run