Find the subscription of an organization using its ID

GET /organizations/{organizationId}/billing/subscription

Try it

Find the subscription of an organization using its ID

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId}/billing/subscription \
  --header 'Authorization: Bearer <token>'

200

{
  "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

Example:

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

Response

200

application/json

Details of the organziation's current subscription

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

Show child attributes

currentBillingPeriod. startDate · string<date-time> · required

currentBillingPeriod. endDate · string<date-time> · required

currentBillingPeriod. usagesCount · number

shouldLockEnvironmentSwitch · boolean

coupons · object[]

Show child attributes

coupons. coupon · string · required

Maximum string length: 255

Example:

"An example name"