Skip to main content
POST
/
api
/
v1
/
resource-claims
/
{subscriptionId}
/
release
Release Resource
curl --request POST \
  --url https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/release \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceSlug": "<string>",
  "quantity": 123,
  "externalId": "<string>",
  "externalIds": [
    "<string>"
  ],
  "claimIds": [
    "<string>"
  ]
}
'
{
  "releasedClaims": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "organizationId": "<string>",
      "subscriptionItemFeatureId": "<string>",
      "resourceId": "<string>",
      "subscriptionId": "<string>",
      "pricingModelId": "<string>",
      "externalId": "<string>",
      "claimedAt": 0,
      "releaseReason": "<string>",
      "releasedAt": 0,
      "metadata": {}
    }
  ],
  "usage": {
    "capacity": 0,
    "claimed": 0,
    "available": 0
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

subscriptionId
string
required

Body

application/json
resourceSlug
string
required

The slug of the resource to release

quantity
integer

Release N anonymous (cattle-style) claims. Only releases claims where externalId IS NULL. Will not release pet-style claims with externalIds.

Required range: x <= 9007199254740991
externalId
string

Release a specific pet-style claim by its externalId

Maximum string length: 255
externalIds
string[]

Release multiple pet-style claims by their externalIds

Minimum array length: 1
Maximum string length: 255
claimIds
string[]

Release specific claims by their claim IDs (works for both cattle and pet claims)

Minimum array length: 1

Response

Successful response

releasedClaims
object[]
required
usage
object
required