Reporting

Get fulfillment cost report

Summarize fulfillment face value, fees, and cost by program, status, and currency. This report does not accept created_after or created_before.

get/v1/reports/fulfillment-cost

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/reports/fulfillment-cost
Auth: HTTP bearer

Query parameters

period_startstring date-time required

Start of the reporting period, inclusive, RFC 3339.

period_endstring date-time required

End of the reporting period, inclusive, RFC 3339.

program_idstring uuid

Filter to a specific program

Response

Fulfillment cost report

period_endstring

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

period_startstring

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

Example response

{
  "data": [
    {
      "cost": {
        "amount_minor": 2500,
        "currency": "USD"
      },
      "count": 42,
      "face_currency": "USD",
      "face_value": {
        "amount_minor": 2500,
        "currency": "USD"
      },
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "program_name": "Premium Rewards",
      "provider_fee": {
        "amount_minor": 2500,
        "currency": "USD"
      },
      "status": "SUCCEEDED"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  },
  "period_end": "2027-12-31T23:59:59Z",
  "period_start": "2027-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.