Partial Update Credits Auto Top-up Settings

PATCH 
/account/credits/top-up/settings/

Request

application/json

Body

auto_top_up_on_expiration booleanrequired

If true, buy credits automatically on the expiration date of purchased credits.

auto_top_up_on_insufficient booleanrequired

If true, buy credits automatically when the account balance is insufficient to perfom scans.

auto_top_up_credits_pack objectnullable
id stringrequired
Possible values: <= 100 characters
name stringrequired
Possible values: <= 50 characters
price integerrequired
Possible values: >= -2147483648 and <= 2147483647
currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
• USD - USD
• EUR - EUR
• GBP - GBP
pack_amount int64required
Possible values: <= 4294967295
discount integerrequired
savings integerrequired

application/x-www-form-urlencoded

Body

auto_top_up_on_expiration booleanrequired

If true, buy credits automatically on the expiration date of purchased credits.

auto_top_up_on_insufficient booleanrequired

If true, buy credits automatically when the account balance is insufficient to perfom scans.

auto_top_up_credits_pack objectnullable
id stringrequired
Possible values: <= 100 characters
name stringrequired
Possible values: <= 50 characters
price integerrequired
Possible values: >= -2147483648 and <= 2147483647
currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
• USD - USD
• EUR - EUR
• GBP - GBP
pack_amount int64required
Possible values: <= 4294967295
discount integerrequired
savings integerrequired

multipart/form-data

Body

auto_top_up_on_expiration booleanrequired

If true, buy credits automatically on the expiration date of purchased credits.

auto_top_up_on_insufficient booleanrequired

If true, buy credits automatically when the account balance is insufficient to perfom scans.

auto_top_up_credits_pack objectnullable
id stringrequired
Possible values: <= 100 characters
name stringrequired
Possible values: <= 50 characters
price integerrequired
Possible values: >= -2147483648 and <= 2147483647
currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
• USD - USD
• EUR - EUR
• GBP - GBP
pack_amount int64required
Possible values: <= 4294967295
discount integerrequired
savings integerrequired

Responses

201

application/json

Schema

Schema

auto_top_up_on_expiration booleanrequired

If true, buy credits automatically on the expiration date of purchased credits.

auto_top_up_on_insufficient booleanrequired

If true, buy credits automatically when the account balance is insufficient to perfom scans.

auto_top_up_credits_pack objectnullable
id stringrequired
Possible values: <= 100 characters
name stringrequired
Possible values: <= 50 characters
price integerrequired
Possible values: >= -2147483648 and <= 2147483647
currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
• USD - USD
• EUR - EUR
• GBP - GBP
pack_amount int64required
Possible values: <= 4294967295
discount integerrequired
savings integerrequired

Example (from schema)

{
  "auto_top_up_on_expiration": true,
  "auto_top_up_on_insufficient": true,
  "auto_top_up_credits_pack": {
    "id": "string",
    "name": "string",
    "price": 0,
    "currency_code": "USD",
    "pack_amount": 0,
    "discount": 0,
    "savings": 0
  }
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...