Create an account for a tenant
/v1/accountsPartner only. Creates the account as pending_payment and returns a Stripe Checkout link. Calling again for the same external_ref returns the same account (201 the first time, 200 after), with a fresh link while it is unpaid. The account becomes active when Stripe confirms payment, and account.activated is sent to the partner. With free_access: true (partners Presslane Suppliers set up for it) the account is active at once on the partner’s free plan, with no Checkout and no charge; sent for an existing tenant it gives that tenant free access (a subscription it pays is paused).
- Called by
- Partner client
- Scope
- accounts:write
Headers
- Idempotency-Keystring
A repeat within 24 hours returns the first response.
Request body · application/json
- billing_emailstring (email)required
- cancel_urlstring (uri)
Required unless
free_accessis true. - external_refstringrequired
The partner's tenant ID. One account per tenant.
- free_accessboolean
true: the tenant uses the API free, on the free plan Presslane Suppliers set up for the partner (the plan in GET /v1/plans with
free_access: true). The account is active at once and there is no Checkout. 403 if the partner has no free plan. - namestringrequired
Business name.
- planstring
Plan code from GET /v1/plans. Required unless
free_accessis true. - success_urlstring (uri)
Where Stripe sends the tenant after paying. Must start with one of the partner's allowed return URLs. Required unless
free_accessis true.
Responses
200The existing account for this tenant.Show
- accountAccountrequired
Child attributes
- activated_atstring (date-time) | nullrequired
- allowancesobjectrequired
Null: unlimited.
Child attributes
- api_requests_per_monthinteger | nullrequired
- linked_variantsinteger | nullrequired
- billing_emailstringrequired
- cancel_atstring (date-time) | nullrequired
- complimentarybooleanrequired
No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.
- created_atstring (date-time)required
- ended_atstring (date-time) | nullrequired
- external_refstringrequired
The partner's tenant ID.
- free_accessbooleanrequired
The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has
complimentary: trueandfree_access: false, and only Presslane Suppliers can end it. - idstringrequired
- namestringrequired
- planobject | nullrequired
Child attributes
- codestringrequired
- namestringrequired
- sandboxbooleanrequired
A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status
test) and never sent to a supplier. Only Presslane Suppliers sets it. - scheduled_planobject | nullrequired
A downgrade waiting for the period end.
Child attributes
- codestringrequired
- fromstring (date-time) | nullrequired
- namestringrequired
- statusstringrequired
activeandpast_duecan use data endpoints; others answer 403account_suspended.One of
pending_payment,active,past_due,suspended,cancelled,closed - subscriptionobject | nullrequired
Child attributes
- cancel_at_period_endbooleanrequired
- current_period_endstring (date-time) | nullrequired
- last_payment_errorstring | nullrequired
- priceobject | nullrequired
Child attributes
- amount_minorintegerrequired
- currencystringrequired
- intervalstringrequired
Always
month
- statusstring | nullrequired
- trial_endstring (date-time) | nullrequired
- suspended_reasonstring | nullrequired
One of
unpaid,cancelled,locked,manual - usageobjectrequired
Child attributes
- api_requestsintegerrequired
- linked_variantsintegerrequired
- period_endstring (date)required
- period_startstring (date)required
- checkout_expires_atstring (date-time) | nullrequired
- checkout_urlstring | nullrequired
Stripe Checkout. Null when no payment is needed (already active, free access, complimentary or a free plan).
201Created.Show
- accountAccountrequired
Child attributes
- activated_atstring (date-time) | nullrequired
- allowancesobjectrequired
Null: unlimited.
Child attributes
- api_requests_per_monthinteger | nullrequired
- linked_variantsinteger | nullrequired
- billing_emailstringrequired
- cancel_atstring (date-time) | nullrequired
- complimentarybooleanrequired
No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.
- created_atstring (date-time)required
- ended_atstring (date-time) | nullrequired
- external_refstringrequired
The partner's tenant ID.
- free_accessbooleanrequired
The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has
complimentary: trueandfree_access: false, and only Presslane Suppliers can end it. - idstringrequired
- namestringrequired
- planobject | nullrequired
Child attributes
- codestringrequired
- namestringrequired
- sandboxbooleanrequired
A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status
test) and never sent to a supplier. Only Presslane Suppliers sets it. - scheduled_planobject | nullrequired
A downgrade waiting for the period end.
Child attributes
- codestringrequired
- fromstring (date-time) | nullrequired
- namestringrequired
- statusstringrequired
activeandpast_duecan use data endpoints; others answer 403account_suspended.One of
pending_payment,active,past_due,suspended,cancelled,closed - subscriptionobject | nullrequired
Child attributes
- cancel_at_period_endbooleanrequired
- current_period_endstring (date-time) | nullrequired
- last_payment_errorstring | nullrequired
- priceobject | nullrequired
Child attributes
- amount_minorintegerrequired
- currencystringrequired
- intervalstringrequired
Always
month
- statusstring | nullrequired
- trial_endstring (date-time) | nullrequired
- suspended_reasonstring | nullrequired
One of
unpaid,cancelled,locked,manual - usageobjectrequired
Child attributes
- api_requestsintegerrequired
- linked_variantsintegerrequired
- period_endstring (date)required
- period_startstring (date)required
- checkout_expires_atstring (date-time) | nullrequired
- checkout_urlstring | nullrequired
Stripe Checkout. Null when no payment is needed (already active, free access, complimentary or a free plan).
- 400The request is not valid (
invalid_request). - 401Missing, expired or revoked token (
invalid_token). - 403The token lacks a scope (
insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this. - 409Conflict, including a reused
Idempotency-Key(idempotency_conflict). - 429Too many requests (
rate_limited); seeRetry-After.
curl -sS -X POST 'https://suppliers.presslane.ai/v1/accounts' \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
--data '{"billing_email":"jo@example.com","external_ref":"string","name":"string","plan":"starter"}'{
"account": {
"activated_at": "2026-11-09T08:00:00Z",
"allowances": {
"api_requests_per_month": 1,
"linked_variants": 1
},
"billing_email": "string",
"cancel_at": "2026-11-09T08:00:00Z",
"complimentary": false,
"created_at": "2026-11-09T08:00:00Z",
"ended_at": "2026-11-09T08:00:00Z",
"external_ref": "string",
"free_access": false,
"id": "acc_01jd6y…",
"name": "string",
"plan": {
"code": "string",
"name": "string"
},
"sandbox": false,
"scheduled_plan": {
"code": "string",
"from": "2026-11-09T08:00:00Z",
"name": "string"
},
"status": "pending_payment",
"subscription": {
"cancel_at_period_end": false,
"current_period_end": "2026-11-09T08:00:00Z",
"last_payment_error": "string",
"price": {
"amount_minor": 1,
"currency": "string",
"interval": "month"
},
"status": "string",
"trial_end": "2026-11-09T08:00:00Z"
},
"suspended_reason": "unpaid",
"usage": {
"api_requests": 1,
"linked_variants": 1,
"period_end": "2026-11-21",
"period_start": "2026-11-21"
}
},
"checkout_expires_at": "2026-11-09T08:00:00Z",
"checkout_url": "string"
}