Get settings

Gets settings of the current environment.

GET /environments/settings

Get settings

cURL

curl --request GET \
  --url https://api.example.com/environments/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'x-environment: <x-environment>'

200

{
  "handles": {
    "invoicePrefix": "<string>",
    "customerPrefix": "<string>",
    "subscriptionPrefix": "<string>"
  },
  "invoice": {
    "seed": 123
  },
  "paymentTerm": {
    "defaultTerm": "<string>"
  }
}

Headers

x-environment · string<uuid> · required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Response

200

application/json

OK

handles · object · required

Show child attributes

invoice · object · required

Show child attributes

paymentTerm · object · required

Show child attributes