Skip to main content
PUT
/
organizations
/
{organizationId}
/
billing
/
subscription
/
coupon
Add coupon to subscription
curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId}/billing/subscription/coupon \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coupon": "An example name"
}
'
{
  "hasPaymentMethod": true,
  "planType": "free",
  "inTrial": true,
  "scope": [
    "<string>"
  ],
  "version": "<string>",
  "billingPortalUrl": "<string>",
  "billingPortalAddPaymentMethodUrl": "<string>",
  "trialStart": "2023-11-07T05:31:56Z",
  "trialEnd": "2023-11-07T05:31:56Z",
  "trialDaysLeft": 123,
  "currentBillingPeriod": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "usagesCount": 123
  },
  "shouldLockEnvironmentSwitch": true,
  "coupons": [
    {
      "coupon": "An example name"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

ID of organization

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

User new fields data

​
coupon
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

Response

Success

​
hasPaymentMethod
boolean
required
​
planType
enum<string>
required
Available options:
free,
advanced,
enterprise,
standard
​
inTrial
boolean
required
​
scope
string[]
required
​
version
string
required
​
billingPortalUrl
string
​
billingPortalAddPaymentMethodUrl
string
​
trialStart
string<date-time>
​
trialEnd
string<date-time>
​
trialDaysLeft
number
​
currentBillingPeriod
object
​
shouldLockEnvironmentSwitch
boolean
​
coupons
object[]