Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Organizations

Add coupon to subscription

put/organizations/{organizationId}/billing/subscription/coupon

Path parameters

organizationIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of organization

Request body

couponstring required

Example request

{
  "coupon": "An example name"
}

Response

Success

billingPortalUrlstring
billingPortalAddPaymentMethodUrlstring
hasPaymentMethodboolean required
planType'free' | 'advanced' | 'enterprise' | 'standard' required
inTrialboolean required
scopestring[] required
trialStartstring date-time
trialEndstring date-time
trialDaysLeftnumber
versionstring required
shouldLockEnvironmentSwitchboolean

Example response

{
  "coupons": [
    {
      "coupon": "An example name"
    }
  ]
}