STstiggio
Coupons

Create coupon

Changed on

Creates a new discount coupon with percentage or fixed amount off, applicable to customer subscriptions.

post/api/v1/coupons

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/coupons
  • Auth
    API key in header X-API-KEY

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

namestring required

Name of the coupon

descriptionstring nullable required

Description of the coupon

percentOffnumber nullable required

Percentage discount off the original price

durationInMonthsinteger nullable required

Duration of the coupon validity in months

metadataobject nullable required

Metadata associated with the entity

Response

The newly created coupon object.

Changes

  • b876edd1a4fcRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

  • 58bb216ff8ceRevision changes
    • warning

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