List the Organization's Funding Benefits

GET https://api.suger.cloud/org/{orgId}/funding/benefit

List the AWS benefit wallets this organization holds — the funding AWS has set aside for it, and how much of each is left. One entry per wallet, with its program (MDF, POC, MAP, ISVWMP, MPOPP:Grow, MPOPP:Activate, PIF:SCA GenAI POC or PIF:SCA GenAI MDF), status, currency, start and expiry, and the amounts its fulfillment type carries: a consumable allocation reports allocated, utilized and remaining, a credit allocation reports allocated and issued, and a disbursement reports what was paid out. Per-application drawdowns — cash claims and credit issued against a funding application — draw on a wallet already listed and are not returned; access-type (non-monetary) allocations are not listed either. Read the fulfillmentType field to know which amounts apply. Narrow with the program parameter, to one program or to a family: MPOPP covers both MPOPP programs and PIF both PIF programs. These are balances, not approvals: spending a benefit against a deal is a separate funding application.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`program`	query	string	no	Filter by funding program (e.g. MAP, POC, MPOPP:Grow) or by family (MPOPP, PIF), case-insensitive

Responses

200 — Success

Content-Type: application/json

FundingBenefit fields:

Field	Type	Required	Description
`allocatedAmount`	string	no	AllocatedAmount is the total AWS set aside. Nil when the kind does not carry it.
`allocationId`	string	no	AllocationID is the AWS benefit allocation id (`ben-alloc-...`).
`benefitId`	string	no	BenefitID is the AWS benefit this allocation draws on (`ben-...`).
`catalog`	string	no	Catalog is the AWS catalog the allocation lives in — "AWS" in production, "Sandbox" in test.
`currency`	string	no	Currency is the currency of every amount above.
`disbursedAmount`	string	no	DisbursedAmount is cash already paid out. Disbursement only.
`expiresAt`	string	no	ExpiresAt is when it stops being drawable. An expired allocation still appears here, with its remaining amount, because "why can we not use this" is a question worth answering.
`fulfillmentType`	string	no	FulfillmentType says which amounts below are populated: `consumable` carries all three, `credit` carries allocated and issued, and `disbursement` carries disbursed. Access-type allocations — non-monetary benefits with no balance — are not returned, as in the console wallet. The wallet shows only the consumable kind, because its donut needs all three; this API returns each wallet whatever its monetary kind and names which it is. Per-application drawdowns — cash claims and credit issued against a funding application — draw on a wallet already listed and are not returned.
`fundingApplicationId`	string	no	FundingApplicationID is the Fours row this allocation was read from.
`issuedAmount`	string	no	IssuedAmount is the value of credit codes issued. Credit only.
`name`	string	no	Name is AWS's own name for the allocation.
`program`	string	no	Program is the funding program this benefit belongs to — MDF, POC, MAP, ISVWMP, "MPOPP:Grow", "MPOPP:Activate", "PIF:SCA GenAI POC" or "PIF:SCA GenAI MDF". Empty when the benefit id is not one Fours recognises for the allocation's catalog, which is why BenefitID is returned alongside it rather than replaced by it.
`remainingAmount`	string	no	RemainingAmount is what is left to draw — the figure "how much funding do we have left" asks for. Consumable only.
`startsAt`	string	no	StartsAt is when the allocation becomes drawable.
`status`	string	no	Status is the allocation's AWS status; only an active one can be drawn against.
`statusReason`	string	no	StatusReason explains a non-active status when AWS gave one.
`utilizedAmount`	string	no	UtilizedAmount is how much has been drawn. Consumable only.

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/org/{orgId}/funding/benefit' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

[
  {
    "allocatedAmount": "string",
    "allocationId": "01H0000000000000000000",
    "benefitId": "01H0000000000000000000",
    "catalog": "string",
    "currency": "USD",
    "disbursedAmount": "string",
    "expiresAt": "2026-01-31T12:00:00Z",
    "fulfillmentType": "string",
    "fundingApplicationId": "01H0000000000000000000",
    "issuedAmount": "string",
    "name": "Acme Corp",
    "program": "string"
  }
]

Error — 400

"string"

View as Markdown · API reference overview

Spotted something wrong or out of date on this page? Tell us and we'll correct it.