raims accounts

Get the account number.

GET /v1/accounts/account_number

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: Production.

Prepare a checkout favicon upload.

POST /v1/accounts/checkout_settings/favicon_uploads

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.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  content_type  string   required; allowed: "image/png", "image/jpeg"
  file_size     integer  required
  height        integer  required
  width         integer  required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "content_type": "image/png",
  "file_size": 4567,
  "width": 128,
  "height": 128
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Without --upload-file, this operation prepares an upload using JSON metadata and returns the API's upload instructions. Use --upload-file PATH to read a PNG or JPEG, prepare its metadata and upload its bytes. Do not combine it with --data-file or body options. With --dry-run, the file is validated locally and only the metadata request is previewed. Uploading does not apply the image: update checkout settings with the returned upload ID in a separate request.

With --upload-file, image metadata is read from the same bytes that are uploaded. The file must be PNG or JPEG, up to 524288 bytes, with width 128..512 pixels and height 128..512 pixels. The favicon must be square. --dry-run validates the local file and previews only the preparation request; it does not upload bytes. Apply the returned upload ID separately to change the checkout image.

Get checkout appearance settings.

GET /v1/accounts/checkout_settings

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.

Prepare a checkout logo upload.

POST /v1/accounts/checkout_settings/logo_uploads

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.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  content_type  string   required; allowed: "image/png", "image/jpeg"
  file_size     integer  required
  height        integer  required
  width         integer  required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "content_type": "image/png",
  "file_size": 12345,
  "width": 512,
  "height": 128
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Without --upload-file, this operation prepares an upload using JSON metadata and returns the API's upload instructions. Use --upload-file PATH to read a PNG or JPEG, prepare its metadata and upload its bytes. Do not combine it with --data-file or body options. With --dry-run, the file is validated locally and only the metadata request is previewed. Uploading does not apply the image: update checkout settings with the returned upload ID in a separate request.

With --upload-file, image metadata is read from the same bytes that are uploaded. The file must be PNG or JPEG, up to 524288 bytes, with width 128..2048 pixels and height 128..2048 pixels. --dry-run validates the local file and previews only the preparation request; it does not upload bytes. Apply the returned upload ID separately to change the checkout image.

Update checkout appearance settings.

PATCH /v1/accounts/checkout_settings

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.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  favicon_upload_id    string  optional, nullable
  hex_primary_color    string  optional
  hex_secondary_color  string  optional
  logo_upload_id       string  optional, nullable
  support_email        string  optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "logo_upload_id": "cau_3AbHiWSrsZBoaTg47OcMzC",
  "favicon_upload_id": "cau_1AbXiWSrsCBoaTg47OcMzC"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Discard a prepared checkout image upload.

DELETE /v1/accounts/checkout_settings/uploads/{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.

Get the authenticated account context.

GET /v1/accounts/context

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.

Get account fees.

GET /v1/accounts/fees

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.