Read Benefit
Intent
Reads the benefit without changing it.
When to call it
Call this after your application has received or stored the identifier for the benefit.
Access boundary
Authorize the request with a token that carries benefits:read or benefits:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get a benefit by ID.
Scopes: benefits:read benefits:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The benefit ID.
Response
Successful Response
- BenefitCustom
- BenefitDiscord
- BenefitGitHubRepository
- BenefitDownloadables
- BenefitLicenseKeys
- BenefitMeterCredit
- BenefitFeatureFlag
A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
The ID of the benefit.
The time Ruba created this record.
The time this record last changed.
"custom"The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
Whether the benefit is deleted.
The ID of the organization owning the benefit.
The visibility of the benefit in the customer portal.
draft, private, public Properties for a benefit of type custom.