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.
Authorizations
Path Parameters
Identifier of the benefit.
Response
Request completed successfully
- 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.
Unique identifier for the benefit.
The time Ruba created this record.
The time this record last changed.
"custom"Description attached to the benefit.
Indicates whether the benefit is selectable when creating a product.
Indicates whether the benefit is deletable.
Indicates whether the benefit is deleted.
Unique identifier for the organization owning the benefit.
Visibility: Controls whether customers can see this benefit in their portal.
draft, private, public Properties for a benefit of type custom.