Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
products
public

Update Product Benefits

Update benefits granted by a product.

Scopes: products:write

post/v1/products/{id}/benefits

Path parameters

idstring uuid4 required

The product ID.

Request body

benefitsstring[] required

List of benefit IDs. Each one must be on the same organization as the product.

Response

Product benefits updated.

idstring uuid4 required

The ID of the object.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

trial_interval'day' | 'week' | 'month' | 'year' required
trial_interval_countinteger nullable required

The number of interval units for the trial period.

namestring required

The name of the product.

descriptionstring nullable required

The description of the product.

visibility'draft' | 'private' | 'public' required
recurring_interval'day' | 'week' | 'month' | 'year' required
recurring_interval_countinteger nullable required

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.

meter_interval'day' | 'week' | 'month' | 'year' required
meter_interval_countinteger nullable required

Number of meter interval units. None when no meter cycle is set.

is_recurringboolean required

Whether the product is a subscription.

is_archivedboolean required

Whether the product is archived and no longer available.

organization_idstring uuid4 required

The ID of the organization owning the product.

metadataMetadataOutputType required

Example response

{
  "benefits": [
    {
      "properties": {
        "repository_owner": "polarsource",
        "repository_name": "private_repo"
      }
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field": {
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
      }
    }
  ]
}