Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Product Catalog

Publish add-on

Publish a add-on version.

post/api/v1/addons/{addonId}/publish

Path parameters

addonIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

The request has succeeded.

idstring required

A unique identifier for the resource.

namestring required

Human-readable name for the resource. Between 1 and 256 characters.

descriptionstring

Optional description of the resource. Maximum 1024 characters.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

createdAtstring date-time required

Timestamp of when the resource was created.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

keystring required

A semi-unique identifier for the resource.

annotationsAnnotations

Set of key-value pairs managed by the system. Cannot be modified by user.

versioninteger required

Version of the add-on. Incremented when the add-on is updated.

instanceType'single' | 'multiple' required

The instanceType of the add-on. Single instance add-ons can be added to subscription only once while add-ons with multiple type can be added more then once.

currencystring required

Three-letter ISO4217 currency code. Custom three-letter currency codes are also supported for convenience.

effectiveFromstring date-time

The date and time when the add-on becomes effective. When not specified, the add-on is a draft.

effectiveTostring date-time

The date and time when the add-on is no longer effective. When not specified, the add-on is effective indefinitely.

status'draft' | 'active' | 'archived' required

The status of the add-on defined by the effectiveFrom and effectiveTo properties.

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "createdAt": "2024-01-01T01:01:01.001Z",
  "updatedAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "annotations": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "currency": "USD",
  "effectiveFrom": "2023-01-01T01:01:01.001Z",
  "effectiveTo": "2023-01-01T01:01:01.001Z",
  "rateCards": [
    {
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "entitlementTemplate": {
        "metadata": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        }
      },
      "taxConfig": {
        "stripe": {
          "code": "txcd_10000000"
        },
        "taxCodeId": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "discounts": {
        "percentage": {
          "percentage": 50
        }
      }
    }
  ],
  "validationErrors": [
    {
      "field": "addons/pro/ratecards/token/featureKey",
      "code": "invalid_feature_key",
      "message": "not found feature by key",
      "attributes": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      }
    }
  ]
}