Skip to main content
POST
/
api
/
v1
/
resource-claims
/
{subscriptionId}
/
claim
Claim Resource
curl --request POST \
  --url https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/claim \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceSlug": "<string>",
  "metadata": {},
  "quantity": 123,
  "externalId": "<string>",
  "externalIds": [
    "<string>"
  ]
}
'
{
  "claims": [
    {
      "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 claim

metadata
object

Optional metadata to attach to the claim(s)

quantity
integer

Create N anonymous (cattle-style) claims. Each claim will have externalId = null.

Required range: x <= 9007199254740991
externalId
string

Create a single pet-style claim with this external identifier.

Maximum string length: 255
externalIds
string[]

Create multiple pet-style claims with these external identifiers.

Minimum array length: 1
Maximum string length: 255

Response

Successful response

claims
object[]
required
usage
object
required