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

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

GET /project/charges HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "amount": 15000,
      "charged_at": "2026-04-28T15:30:00+00:00",
      "currency": "USD",
      "customer_id": 101,
      "id": 8801,
      "project_id": 42
    }
  ],
  "pagination": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/project/charges",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

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 an existing project location. Returns 404 if the slug is not found.

charged_atone of · nullableOptional

Optional instant for request bodies: Unix timestamp as integer (seconds), or a date/time string of at most 50 characters that PHP Carbon can parse. For strings, ISO-8601 / RFC 3339 (for example 2026-04-28T15:30:00Z) is the recommended format in examples and client integrations. Invalid values fail validation. When the field is omitted or null, the API uses the current server time where that behavior is documented on the operation.

integerOptional

Unix timestamp in seconds since the Unix epoch.

or

string · max: 50Optional

Date/time string parseable by Carbon; prefer ISO-8601 / RFC 3339; maximum 50 characters.

Responses

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

POST /project/charges HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "amount": 15000,
  "email": "[e-mail]",
  "phone": "[phone]",
  "currency": "USD",
  "location_slug": "downtown",
  "charged_at": "2026-04-28T15:30:00Z"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "email": "[e-mail]",
    "phone": "[phone]",
    "amount": 15000,
    "currency": "USD",
    "charged_at": "2026-04-28T15:30:00+00:00"
  }
}

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

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 this API.

delete/charges/{id}

DELETE /project/charges/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}