The 'cclAmount' field is deprecated.

CCL amount should not be passed in by the API.

- Marked as deprecated on 2022-10-18.
- Scheduled for removal on or after 2024-01-01.

displayNote : String

Optional short note about account charge for customer display.

grossAmount : Int!


            required

The gross amount of the charge to be added, in the smallest units of currency (e.g. cents).

metadata : JSONString

Any extra data that will be associated with account charge.

netAmount : Int

The net amount of the charge to be added.

Deprecation

The 'netAmount' field is deprecated.

The net amount will be calculated automatically by the gross amount.

- Marked as deprecated on 2022-10-18.
- Scheduled for removal on or after 2024-01-01.

note : String

Optional short note about account charge for internal use.

reason : String!


            required

The reason why the charge is added to the account. This should be a valid charge reason code.

salesTaxAmount : Int

The sales tax amount of the charge to be added.

Deprecation

The 'salesTaxAmount' field is deprecated.

The sales tax amount will be calculated automatically by the gross amount.

- Marked as deprecated on 2022-10-18.
- Scheduled for removal on or after 2024-01-01.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{
  "accountNumber": "A-9157E800",
  "displayNote": "field-left-else-college-member",
  "grossAmount": 35,
  "metadata": {"key": "value"},
  "note": "member-seat-institution-great-prevent",
  "reason": "after-medical-watch-real-I"
}