Skip to content
Console
On this page

List credit grants

Lists credit grants.

Lists credit grants.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/credit_grants
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection credit_grants
  • Query page_size, page_token, filter
  • Pagination the answer carries credit_grants and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe parent to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter, for example subject = "…".

Response

FieldTypeWhat it is
credit_grantsCreditGrant[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

CreditGrant

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/credit_grants/{credit_grant}.
uidstringcgrt_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
subjectSubjectWho receives it. Required.
kindstringamount (a total) or monthly_cap (up to the amount in each month). Required.
amount_minorstringMinor units, a decimal string. Required.
start_timetimestampWhen it starts applying. Required.
expire_timetimestampWhen it stops applying; required. Not renewing is how charging starts. Required.
approverstringWho approved it. Required.
reasonstringWhy. Required.
supersedesstringThe grant this one replaces.
tax_treatmentstringundecided, price_reduction, or post_tax_settlement; no default. post_tax_settlement is refused while the merchant has automatic tax on. Required.
collection_modestringstandard or hold; no default. Over the credit, a held invoice stays due but is not collected until an explicit audited release. Required.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

Subject

FieldTypeWhat it is
end_userstringAn end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group.
customer_organizationstringA customer organization's id. One of the kind group.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/credit_grants" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"