Skip to main content
GET
Get fulfillment cost report
Retrieve gift-card order totals grouped by program, fulfillment status, and currency. The report includes face value, fees, and cost for the requested period. The date range selects orders by authorization time, while the status reflects their current outcome. A past period’s breakdown can change as pending orders succeed or fail. Amounts are in minor units of face_currency, such as cents for USD. Asset charges are reported separately in the ledger. provider_fee_minor is 0 for gift cards.
See Reporting for using this report alongside ledger reports.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

from
string<date-time>
required

Period start (inclusive, RFC3339)

to
string<date-time>
required

Period end (inclusive, RFC3339)

program_id
string<uuid>

Filter to a specific program

Response

Fulfillment cost report

Summarize fulfillment face value, fees, and cost by program, status, and currency.

data
object[]

Rows, one per program x status with fulfillment activity in the period

from
string

Period start (inclusive, RFC 3339), echoed from the request

Example:

"2026-01-01T00:00:00Z"

pagination
object

Pagination metadata for list responses

to
string

Period end (inclusive, RFC 3339), echoed from the request

Example:

"2026-01-31T23:59:59Z"