Sign in
Addons

Create an addon

Creates a new addon in draft status, associated with a specific product.

post/api/v1/addons

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

idstring required

The unique identifier for the entity

displayNamestring required

The display name of the package

descriptionstring nullable

The description of the package

productIdstring required

The product id of the package

pricingType'FREE' | 'PAID' | 'CUSTOM' nullable

The pricing type of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

maxQuantityinteger nullable

The maximum quantity of this addon that can be added to a subscription

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED'

The status of the package

metadataobject

Metadata associated with the entity

Response

The newly created addon object.

Changes

Changed in 8 of the 115 revisions of this API.123

  • b876edd1a4fc51See the full diff
    • ●

      added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ○

      removed the InvoicePreviewNotAvailableForDraftContract enum value from the code response property for the response status 409

      response-property-enum-value-removed

  • 58bb216ff8ce1See the full diff
    • ●

      added the new GovernanceNotEnabled enum value to the code response property for the response status 403

      response-property-enum-value-added

  • 7cfc2fd959642See the full diff
    • ●

      the maxQuantity request property's exclusiveMinimum was set to true

      request-property-exclusive-min-set

    • ●

      the maxQuantity request property's min was set to 0.00

      request-property-min-set

  • 7296f9e4b6541See the full diff
    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 409

      response-property-enum-value-added

  • 3acd63d6c8612See the full diff
    • ○

      added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • ○

      added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

  • b181b166a2a51See the full diff
    • ●

      added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added