ACaccessibe

Create an accessWidget license

Creates a new accessWidget license for the specified account.

This endpoint requires the x-api-key header for authentication. The key must match the API key associated with the specified account. The account must also be a partner account.

planSKU is the type of plan for the license where:

1 = Standard, 2 = Advanced Plus, 3 = Enterprise, 5 = Advanced, 21 = Micro, 22 = Growth, 23 = Scale

post/accounts/{accountId}/access-widget-licenses

Request

Path parameters

accountIdstring required

The ID of the account. You can check your ID here.

Request body

domainstring required

Domain name for which the license is being created

planSKU1 | 2 | 3 | 5 | 21 | 22 | 23 required

Plan SKU for the license

contactNamestring

Full name of the contact for this license

contactEmailstring

Contact email address for this license

contactPhonestring

Contact phone number for this license

contactCountryCodestring

Contact country code for this license

discountEnabledboolean

Set to true to enable discounts for the account. Set to false to get commissions instead of discounts. The parameter activate below must be set to true

monthlyboolean

For monthly subscription can pass it as true, else it will be yearly

activateboolean

Activate the license, need to have in the account allowActivationByApi set to true

longTrialboolean

Assign a long trial period for 30 days, need to have in the account allowLongTrialByApi set to true

Example request

{
  "domain": "example.com",
  "planSKU": 1,
  "contactName": "John Doe",
  "contactEmail": "johndoe@accessibe.com",
  "contactPhone": "5551234567",
  "contactCountryCode": "US"
}

Response

License created

successboolean
messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.