Skip to main content
POST
Create an entitlement
Use this endpoint to create a new 1Password product entitlement for a customer. The entitlement starts off as pending until the customer activates it. Creating an entitlement works as follows:
  1. The entitlement is created with a status of pending.
  2. 1Password sends an email to the customer with an activation link. The email includes your distributor name and the product name.
  3. The customer selects the activation link and sets up their new 1Password account, which activates the entitlement and transitions it to active.
Poll the list of entitlements to check the entitlement’s status.
Pending entitlements don’t expire. An entitlement stays pending until the customer activates it or you cancel it. Only pending entitlements can be updated.If an entitlement for the product already exists for the customer, the request fails with a 409 error unless it has a cancelled or expired status.If the existing entitlement is cancelled or expired, it’s reactivated with a status of pending.A reactivated entitlement keeps its original id and create_time, with the contact details from the new request.
The distributor-customer ID in the request path is your own identifier for the customer, as defined in your system, and isn’t validated when you create an entitlement. Make sure your integration passes customer IDs consistently. Retrieve a list of available 1Password products to find the product_id value to use when creating an entitlement.

Authorizations

Authorization
string
header
required

Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed op_b_). Include it in the Authorization header of every request as Bearer <token>.

Path Parameters

distributor-customer
string
required

The customer ID, as defined in the distributor's own system.

Body

application/json

The entitlement resource to create.

A provisioned 1Password product entitlement for a distributor customer.

product_id
string

The ID of the 1Password product. Required on create; immutable thereafter.

contact_info
object

The customer's contact details for account setup.

Response

The newly created entitlement, with status pending.

A provisioned 1Password product entitlement for a distributor customer.

path
string
read-only

The canonical resource path of the entitlement (for example, "distributor-customers/{customer_id}/entitlements/{id}"). Use the IDs in this path to update or cancel the entitlement.

id
string
read-only

The unique identifier for this entitlement.

customer_id
string
read-only

The ID of the marketplace customer who owns this entitlement. This is the distributor-defined ID from the request path that created the entitlement.

product_id
string

The ID of the 1Password product. Required on create; immutable thereafter.

status
enum<string>
read-only

The entitlement lifecycle state.

Available options:
pending,
active,
cancelling,
cancelled,
expired,
suspended
contact_info
object

The customer's contact details for account setup.

create_time
string<date-time>
read-only

The date and time the entitlement was created.

expire_time
string<date-time>
read-only

The date and time the entitlement expires. Set only for change-of-channel entitlements created by linking an entitlement, and omitted for standard entitlements. Customers have 5 days to claim the emailed entitlement code against their existing 1Password account. Claiming the code completes the link; otherwise, the entitlement transitions to expired at this time.