Skip to main content
POST
/
api
/
v1
/
partners
/
accounts
curl --request POST \
  --url https://billing.b5test.eu/api/v1/partners/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_account_uid": "aabee51b-0be2-4a0c-aa39-5bbcbb903d1b",
  "account_type": "I",
  "domain": "b5test.com"
}
'
{
  "customer_account_uid": "aabee51b-0be2-4a0c-aa39-5bbcbb903d1b",
  "account_type": "I",
  "activation_token": "PNS-DEFG1234",
  "domain": "b5test.com",
  "status": "entitled",
  "deployed_members": 0,
  "created_at": "2023-01-23T15:55:58.000Z",
  "updated_at": "2023-01-23T15:55:58.000Z",
  "ends_at": null
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request to initialize a partner account.

​
customer_account_uid
string
required

A unique identifier for the end user's account to be provisioned. It can be up to 80 chars long and consist of alphanumeric characters and hyphens.

​
account_type
string
required

Specifies the type of 1Password account plan to provision - 'I' for Individual, or 'F' for family.

​
domain
string
required

Specifies the 1Password domain to provision the account for. For testing it can be one of 'b5test.com', 'b5test.ca', or 'b5test.eu'. For production, it can be one of '1password.com', '1password.ca', or '1password.eu'. Note that domains can only be used after promotions have been created for a given partnership in the specific domain.

​
ends_at
string<date-time>

Specifies when the 1Password account will be frozen, formatted in RFC-3339.

Response

An Account object is returned upon successful initialization of a partner account.

​
customer_account_uid
string

The unique identifier for the end user's account. It can be up to 80 chars long and consist of alphanumeric characters and hyphens.

​
account_type
string

The current type of the 1Password account - 'I' for Individual, or 'F' for family.

​
activation_token
string

The activation token is a coupon code to link a new or existing 1Password account to a partnership promotion. For example, it can be used for 1Password account creation at https://start.{{1password_domain}}/partnership/redeem?t={{account_type}}&c={{activation_token}} during end-user signup.

​
domain
string

The 1Password domain for which the account was provisioned for. For testing domains, it can be one of 'b5test.com', 'b5test.ca', or 'b5test.eu'. For production, it can be one of '1password.com', '1password.ca', or '1password.eu'.

​
status
string

The provisioning status of the partner account. It can be either 'entitled' for accounts that have been initialized but have not completed 1Password signup, or 'provisioned' for accounts that have completed the 1Password signup process.

​
deployed_members
integer

The number of provisioned users for the 1Password account.

​
created_at
string<date-time>

The timestamp of when the partnership account was created, formatted in RFC-3339.

​
updated_at
string<date-time>

The timestamp of when the partner account was last updated, formatted in RFC-3339. This field will be updated during account status changes.

​
ends_at
string<date-time>

The timestamp of when the partner account will be frozen, formatted in RFC-3339.