The Currency Exchange Settings object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

api_endpoint string required
url string
service_provider string required
disabled boolean

Default: false

access_key string
use_http boolean

Default: false

The Currency Exchange Settings object 
{
  "id": "currency-exchange-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "api_endpoint": "api_endpoint_example",
  "url": "url_example",
  "service_provider": "service_provider_example",
  "disabled": false,
  "access_key": "access_key_example",
  "use_http": false
}
GET /api/accounts/currency-exchange-settings

Retrieve currency exchange settings

Retrieves the current currency exchange settings. This is a singleton resource.

Returns

Returns the currency exchange settings object.

GET /api/accounts/currency-exchange-settings 
curl https://api.overplane.dev/api/accounts/currency-exchange-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "currency-exchange-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "api_endpoint": "api_endpoint_example",
  "url": "url_example",
  "service_provider": "service_provider_example",
  "disabled": false,
  "access_key": "access_key_example",
  "use_http": false
}
PATCH /api/accounts/currency-exchange-settings/{id}

Update a currency exchange settings

Updates the specified currency exchange settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the currency exchange settings to update.

Body parameters

api_endpoint string
url string
service_provider string
disabled boolean

Default: false

access_key string
use_http boolean

Default: false

Returns

Returns the updated currency exchange settings object.

PATCH /api/accounts/currency-exchange-settings/{id} 
curl https://api.overplane.dev/api/accounts/currency-exchange-settings/currency-exchange-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"api_endpoint":"api_endpoint_example","url":"url_example"}'
Response 
{
  "id": "currency-exchange-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "api_endpoint": "api_endpoint_example",
  "url": "url_example",
  "service_provider": "service_provider_example",
  "disabled": false,
  "access_key": "access_key_example",
  "use_http": false
}

Line items

Child objects that belong to this currency exchange settings. These are accessed via the parent's ID.

Currency Exchange Settings Details

Attributes

idx integer
currency_exchange_settings_id string required
key string required
value string required

Endpoints

GET /api/accounts/currency-exchange-settings-details?parent_id={id}
POST /api/accounts/currency-exchange-settings-details
PATCH /api/accounts/currency-exchange-settings-details/{id}
DELETE /api/accounts/currency-exchange-settings-details/{id}
POST /api/accounts/currency-exchange-settings-details/reorder
Currency Exchange Settings Details object 
{
  "id": "currency-exchange-settings-details_abc123",
  "idx": 1,
  "currency_exchange_settings_id": "USD",
  "key": "key_example",
  "value": "value_example"
}

Currency Exchange Settings Result

Attributes

idx integer
currency_exchange_settings_id string required
key string required

Endpoints

GET /api/accounts/currency-exchange-settings-result?parent_id={id}
POST /api/accounts/currency-exchange-settings-result
PATCH /api/accounts/currency-exchange-settings-result/{id}
DELETE /api/accounts/currency-exchange-settings-result/{id}
POST /api/accounts/currency-exchange-settings-result/reorder
Currency Exchange Settings Result object 
{
  "id": "currency-exchange-settings-result_abc123",
  "idx": 1,
  "currency_exchange_settings_id": "USD",
  "key": "key_example"
}