Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Grid Fee Reductions

List grid fee reductions

Retrieve all grid fee reductions for the organization. Customer users will only see their own.

get/grid-fee-reductions

Query parameters

cursorstring nullable
limitnumber
filter[field][operator]string nullable

Filterable fields:

  • status (enum): intended, ordered, rejected, activated, ended
  • customer (string)
  • subscription (string)
  • created_at (date)
  • updated_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

  • status (enum): intended, ordered, rejected, activated, ended
  • customer (string)
  • subscription (string)
  • created_at (date)
  • updated_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all grid fee reductions for the organization. Customer users will only see their own.

object'list' required
next_pagestring nullable
has_moreboolean

Example response

{
  "items": [
    {
      "id": "gfr_mi4f0oda6x9m7gcsvjk0ole1",
      "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1",
      "type": "enwg-14a-module-1",
      "status": "intended",
      "valid_from": "2024-03-14T12:00:00Z",
      "valid_until": "2024-03-14T12:00:00Z",
      "created_at": "2024-03-14T12:00:00Z",
      "updated_at": "2024-03-14T12:00:00Z",
      "customer": "cus_mi4f0oda6x9m7gcsvjk0ole1"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}