Product Catalog

Update add-on assignment for plan

Update add-on assignment for plan.

put/api/v1/plans/{planId}/addons/{planAddonId}

Path parameters

planIdstring required

Example:01G65Z755AFWAKHE12NY0CQ9FH

planAddonIdstring required

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

fromPlanPhasestring required

The key of the plan phase from the add-on becomes available for purchase.

maxQuantityinteger

The maximum number of times the add-on can be purchased for the plan. It is not applicable for add-ons with single instance type.

metadataMetadata

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

Example request

{
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  }
}

Response

The request has succeeded.

annotationsAnnotations

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

createdAtstring date-time required

Timestamp of when the resource was created.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

fromPlanPhasestring required

The key of the plan phase from the add-on becomes available for purchase.

maxQuantityinteger

The maximum number of times the add-on can be purchased for the plan. It is not applicable for add-ons with single instance type.

metadataMetadata

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

updatedAtstring date-time required

Timestamp of when the resource was last updated.

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.