Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Charges

View charge

Find a single charge by ID.

get/v1/Charges/{id}

Path parameters

idinteger required

Format - int32. ID of the charge to view.

Response

OK

okboolean
charge_idinteger

Primary identifier for this charge.

product_idinteger

Id of product associated with this charge

product_type_idinteger

Id of product type associated with this charge

customer_idinteger required

Id of customer associated with this charge

bill_idinteger

ID of bill the charge is applied to.

service_idinteger

Id of service associated with this charge

service_product_idinteger

Id of service product associated with this charge

is_tax_includedboolean required

Is tax included in the amount of the charge

tax_class_idinteger

Id of Tax related to charge

descriptionstring required

Description of this charge

amountnumber double

Total dollar amount including taxes and product amounts on charge.

costnumber double required

Cost associated to this charge

product_amountnumber double

Dollar amount of product on this charge.

is_commission_exemptedboolean required

Is commission exempted from this charge

tax_amountnumber double

Tax amount on this charge.

geocodestring

Location of the charge.

prorationnumber double

Quantity of proration associated to this charge

created_datestring date-time

Date the charge was created.

created_byinteger

ID of user that created the charge.

quantitynumber double required

Units of product or product type on the transaction.

ratenumber double required

Rate of product associated to this transaction

is_proratedboolean required

Is proration of transaction required

start_datestring date-time required

Billing start date of product or product type associated to this transaction

end_datestring date-time required

Billing end date of product or product type associated to this transaction