Charges

List Charges

get

Paginated revenue charge rows for the authenticated project with optional calendar bounds on charged-at times.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
date_fromstring · date · nullableOptional

Inclusive lower calendar date for filtering charges by charged-at time (YYYY-MM-DD).

date_tostring · date · nullableOptional

Inclusive upper calendar date for filtering charges by charged-at time (YYYY-MM-DD). Must be on or after date_from when both are provided.

limitinteger · nullableOptional

Maximum number of records to return per page.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get
/charges
200

Success

Create Charge

post

Record a customer revenue event from an external billing system.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Object containing response data for this resource.

amountintegerRequired

Charge amount in the smallest currency unit.

emailstringOptional

Email address for the person or customer.

phonestringOptional

Phone number for the person or customer.

currencystringOptional

Three-letter ISO currency code.

location_slugstringOptional

Slug of the location associated with the record.

charged_atstringOptional

Timestamp or date when the charge occurred.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post
/charges
200

Success

Delete Charge

delete

Permanently remove a mistaken charge row scoped to this project’s customers.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for this charge row.

Responses
chevron-right
200

Success

application/json

Object confirming the charge row was deleted.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

delete
/charges/{id}
200

Success

Last updated