Create Benefit
Intent
Creates a benefit from the values supplied in the request.
When to call it
Call this when your application has collected the required values and is ready to create a benefit.
Access boundary
Authorize the request with a token that carries benefits:write.
Successful result
A successful request returns 201. The response schema below defines the body your integration receives.
Authorizations
Body
- BenefitCustomCreate
- BenefitDiscordCreate
- BenefitGitHubRepositoryCreate
- BenefitDownloadablesCreate
- BenefitLicenseKeysCreate
- BenefitMeterCreditCreate
- BenefitFeatureFlagCreate
Schema used to create a benefit of type custom.
"custom"Description attached to the benefit. Will be displayed on products having this benefit.
3 - 42Properties for creating a benefit of type custom.
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Visibility: Controls whether customers can see this benefit in their portal.
draft, private, public Response
Response: Benefit created.
- 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.